API

IncomingTransfer

An incoming transfer.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method Route SDK operation Returns
GET /incoming-transfers/{incomingTransferId} load GetIncomingTransfer 200 response

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

incoming_transfer, err := client.IncomingTransfer(nil).Load(map[string]any{"id": "example_id"}, nil)
if err != nil {
    panic(err)
}
fmt.Println(incoming_transfer)

Lua

Construct client as shown in the Lua setup, then call the operations:

local incoming_transfer, err = client:IncomingTransfer():load({ id = "example_id" })

PHP

Construct client as shown in the PHP setup, then call the operations:

$incoming_transfer = $client->IncomingTransfer()->load(["id" => "example_id"]);

Python

Construct client as shown in the Python setup, then call the operations:

incoming_transfer = client.IncomingTransfer().load({"id": "example_id"})

Ruby

Construct client as shown in the Ruby setup, then call the operations:

incoming_transfer = client.IncomingTransfer.load({ "id" => "example_id" })

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const incoming_transfer = await client.IncomingTransfer().load({ id: "example_id" })

Fields

Field Type Required Description
accountDetailsId string No Account details ID that received the incoming transfer.
amounts object Yes Payment amount waterfall representing the flow of funds: instructed → interbankSettlement → credited.
balanceId string Yes Balance ID associated with the incoming transfer.
chargeBearer string No Charge bearer code indicating who pays the transaction fees.
creditTransferType string No - CUSTOMER_CREDIT_TRANSFER - End-user or corporate payment where at least one side (debtor or creditor) is a non-financial institution.
creditedTime string Yes Timestamp when the incoming transfer was credited to the balance.
creditor object Yes The creditor (beneficiary) of the incoming transfer.
debtor object Yes The debtor (ordering party) of the incoming transfer.
endToEndId string No End-to-end identifier assigned by the debtor for reconciliation purposes.
exchangeRate number Yes Wise's effective FX rate applied to this incoming transfer (source currency → target balance currency) as a decimal number.
fees object Yes Breakdown of fees applied to the incoming transfer.
id string Yes Unique identifier for the incoming transfer.
previousInstructingAgents array Yes Financial institutions that previously instructed this payment (the historical chain the payment passed through before reaching Wise).
profileId integer Yes Profile ID of the balance owner.
scheme string Yes The payment scheme through which the incoming transfer was received.
state string Yes Current state of the incoming transfer.
uetr string No Universal End-to-End Transaction Reference.
unstructuredReference string No Unstructured remittance information provided by the debtor.

load

GET /incoming-transfers/{incomingTransferId}

Operation ID: GetIncomingTransfer.

Authentication: bearer token (ClientCredentialsToken) or bearer token (UserToken).

Parameters

Parameter In Type Required Description
incomingTransferId path string (uuid) Yes Unique incoming transfer identifier. UUID-formatted string.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: GetIncomingTransfer 200 response

application/json

Property Type Required Description
accountDetailsId string No Account details ID that received the incoming transfer. A balance may have multiple account details (for example multiple IBANs). This identifies the specific one that was credited. Omitted when the payment was received via correspondent model.
amounts object Yes Payment amount waterfall representing the flow of funds: instructed → interbankSettlement → credited.
amounts.credited object Yes The amount credited to the creditor's Wise balance. Computed as interbankSettlement, after any FX conversion and Wise fees.
amounts.credited.currency string Yes ISO 4217 currency code
amounts.credited.value number (decimal) Yes Monetary value
amounts.instructed object Yes The original amount instructed by the debtor. When not specified by scheme, it equals interbankSettlement.
amounts.instructed.currency string Yes ISO 4217 currency code
amounts.instructed.value number (decimal) Yes Monetary value
amounts.interbankSettlement object Yes The amount settled between the instructing and instructed agent on the final interbank leg.
amounts.interbankSettlement.currency string Yes ISO 4217 currency code
amounts.interbankSettlement.value number (decimal) Yes Monetary value
balanceId string Yes Balance ID associated with the incoming transfer. This is the balance that was credited.
chargeBearer enum: DEBTOR, CREDITOR, SHARED, SERVICE_LEVEL No Charge bearer code indicating who pays the transaction fees. Omitted if not specified in the payment message.
creditTransferType enum: CUSTOMER_CREDIT_TRANSFER, FI_CREDIT_TRANSFER No - CUSTOMER_CREDIT_TRANSFER - End-user or corporate payment where at least one side (debtor or creditor) is a non-financial institution. - FI_CREDIT_TRANSFER - Direct bank-to-bank settlement, liquidity movement, or cover transfer where both parties are financial institutions.
creditedTime string (date-time) Yes Timestamp when the incoming transfer was credited to the balance.
creditor object Yes The creditor (beneficiary) of the incoming transfer.
creditor.account object Yes Account details of the creditor
creditor.account.number string Yes Account identifier, IBAN, BBAN, or other scheme-specific account number.
creditor.address object No Address of the creditor
creditor.address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
creditor.address.buildingNumber string No Building number
creditor.address.country string Yes ISO 3166-1 alpha-2 country code
creditor.address.countrySubDivision string No State, province, or region
creditor.address.postCode string No Postal or ZIP code
creditor.address.streetName string No Street name
creditor.address.townName string Yes City or town
creditor.agent object No Financial institution acting as the creditor's agent
creditor.agent.address object No Postal address. Fields are optional and populated based on what the payment rail provides.
creditor.agent.address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
creditor.agent.address.buildingNumber string No Building number
creditor.agent.address.country string Yes ISO 3166-1 alpha-2 country code
creditor.agent.address.countrySubDivision string No State, province, or region
creditor.agent.address.postCode string No Postal or ZIP code
creditor.agent.address.streetName string No Street name
creditor.agent.address.townName string Yes City or town
creditor.agent.bic string No SWIFT BIC (Business Identifier Code) of the financial institution.
creditor.agent.name string No Name of the financial institution.
creditor.agent.nationalCode string No Domestic clearing system membership identifier (for example UK sort code, US ABA routing number).
creditor.agent.nationalCodeType enum: ABA, SORT_CODE No Identifies the domestic clearing system the nationalCode belongs to.
creditor.name string Yes Full name of the creditor.
debtor object Yes The debtor (ordering party) of the incoming transfer.
debtor.account object No Account details of the debtor
debtor.account.number string Yes Account identifier, IBAN, BBAN, or other scheme-specific account number.
debtor.address object No Address of the debtor
debtor.address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
debtor.address.buildingNumber string No Building number
debtor.address.country string Yes ISO 3166-1 alpha-2 country code
debtor.address.countrySubDivision string No State, province, or region
debtor.address.postCode string No Postal or ZIP code
debtor.address.streetName string No Street name
debtor.address.townName string Yes City or town
debtor.agent object No Financial institution acting as the debtor's agent
debtor.agent.address object No Postal address. Fields are optional and populated based on what the payment rail provides.
debtor.agent.address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
debtor.agent.address.buildingNumber string No Building number
debtor.agent.address.country string Yes ISO 3166-1 alpha-2 country code
debtor.agent.address.countrySubDivision string No State, province, or region
debtor.agent.address.postCode string No Postal or ZIP code
debtor.agent.address.streetName string No Street name
debtor.agent.address.townName string Yes City or town
debtor.agent.bic string No SWIFT BIC (Business Identifier Code) of the financial institution.
debtor.agent.name string No Name of the financial institution.
debtor.agent.nationalCode string No Domestic clearing system membership identifier (for example UK sort code, US ABA routing number).
debtor.agent.nationalCodeType enum: ABA, SORT_CODE No Identifies the domestic clearing system the nationalCode belongs to.
debtor.name string Yes Full name of the debtor.
endToEndId string No End-to-end identifier assigned by the debtor for reconciliation purposes. Omitted when not provided by the debtor.
exchangeRate number (decimal) Yes Wise's effective FX rate applied to this incoming transfer (source currency → target balance currency) as a decimal number. 1 when no conversion was needed.
fees object Yes Breakdown of fees applied to the incoming transfer. Contains both Wise fees and correspondent/intermediary bank fees.
fees.correspondent array of object Yes Fees deducted by correspondent or intermediary banks before the funds reached Wise. Each entry includes the charging agent when available in the pacs message. Array is empty where there are no charges.
fees.correspondent[].agent object No The financial institution that deducted this fee. Omitted when the charging agent is not identified in the payment message.
fees.correspondent[].agent.address object No Postal address. Fields are optional and populated based on what the payment rail provides.
fees.correspondent[].agent.address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
fees.correspondent[].agent.address.buildingNumber string No Building number
fees.correspondent[].agent.address.country string Yes ISO 3166-1 alpha-2 country code
fees.correspondent[].agent.address.countrySubDivision string No State, province, or region
fees.correspondent[].agent.address.postCode string No Postal or ZIP code
fees.correspondent[].agent.address.streetName string No Street name
fees.correspondent[].agent.address.townName string Yes City or town
fees.correspondent[].agent.bic string No SWIFT BIC (Business Identifier Code) of the financial institution.
fees.correspondent[].agent.name string No Name of the financial institution.
fees.correspondent[].agent.nationalCode string No Domestic clearing system membership identifier (for example UK sort code, US ABA routing number).
fees.correspondent[].agent.nationalCodeType enum: ABA, SORT_CODE No Identifies the domestic clearing system the nationalCode belongs to.
fees.correspondent[].currency string Yes ISO 4217 currency code.
fees.correspondent[].value number (decimal) Yes Decimal fee amount deducted by the correspondent bank.
fees.wise array of object Yes Fees charged by Wise (for example conversion fee, handling fee). Empty array when no Wise fees apply.
fees.wise[].currency string Yes ISO 4217 currency code.
fees.wise[].type enum: CONVERSION, FIXED_HANDLING, OTHER Yes Category of the Wise fee. Additional fee types will be added in future versions.
fees.wise[].value number (decimal) Yes Decimal fee amount.
id string (uuid) Yes Unique identifier for the incoming transfer. UUID-formatted string.
previousInstructingAgents array of object Yes Financial institutions that previously instructed this payment (the historical chain the payment passed through before reaching Wise). Ordered by position in the chain.
previousInstructingAgents[].address object No Postal address. Fields are optional and populated based on what the payment rail provides.
previousInstructingAgents[].address.addressLines array of string Yes Address lines. May be empty; up to two lines can be populated alongside structured fields.
previousInstructingAgents[].address.buildingNumber string No Building number
previousInstructingAgents[].address.country string Yes ISO 3166-1 alpha-2 country code
previousInstructingAgents[].address.countrySubDivision string No State, province, or region
previousInstructingAgents[].address.postCode string No Postal or ZIP code
previousInstructingAgents[].address.streetName string No Street name
previousInstructingAgents[].address.townName string Yes City or town
previousInstructingAgents[].bic string No SWIFT BIC (Business Identifier Code) of the financial institution.
previousInstructingAgents[].name string No Name of the financial institution.
previousInstructingAgents[].nationalCode string No Domestic clearing system membership identifier (for example UK sort code, US ABA routing number).
previousInstructingAgents[].nationalCodeType enum: ABA, SORT_CODE No Identifies the domestic clearing system the nationalCode belongs to.
profileId integer (int64) Yes Profile ID of the balance owner.
scheme enum: SWIFT, CHAPS, SEPA, SEPA_INSTANT, ACH, FEDWIRE, ... Yes The payment scheme through which the incoming transfer was received.
state enum: CREDITED Yes Current state of the incoming transfer. Additional states will be added in the future.
uetr string (uuid) No Universal End-to-End Transaction Reference. A globally unique identifier (UUID v4) assigned by the debtor agent to track the payment across the entire chain. UUID-formatted string.
unstructuredReference string No Unstructured remittance information provided by the debtor. Free-text field carried through the payment rail.
404: IncomingTransferNotFoundError 404 response
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.