PayinDepositDetail
The bank transfer details for paying in to a transfer.
Operations
Every route this entity exposes. Each route links to its own reference on this page.
| Method | Route | SDK operation | Returns |
|---|---|---|---|
GET |
/profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer |
load |
Payin deposit detail object |
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:
payin_deposit_detail, err := client.PayinDepositDetail(nil).Load(map[string]any{"profile_id": 1, "transfer_id": 1}, nil)
if err != nil {
panic(err)
}
fmt.Println(payin_deposit_detail)
Lua
Construct client as shown in the Lua setup, then call the operations:
local payin_deposit_detail, err = client:PayinDepositDetail():load({ profile_id = 1, transfer_id = 1 })
PHP
Construct client as shown in the PHP setup, then call the operations:
$payin_deposit_detail = $client->PayinDepositDetail()->load(["profile_id" => 1, "transfer_id" => 1]);
Python
Construct client as shown in the Python setup, then call the operations:
payin_deposit_detail = client.PayinDepositDetail().load({"profile_id": 1, "transfer_id": 1})
Ruby
Construct client as shown in the Ruby setup, then call the operations:
payin_deposit_detail = client.PayinDepositDetail.load({ "profile_id" => 1, "transfer_id" => 1 })
TypeScript
Construct client as shown in the TypeScript setup, then call the operations:
const payin_deposit_detail = await client.PayinDepositDetail().load({ profile_id: 1, transfer_id: 1 })
Fields
| Field | Type | Required | Description |
|---|---|---|---|
payinBank |
object |
No | Information about the receiving bank. |
payinBankAccount |
object |
No | Bank account details to use to send the payment to. |
wiseInformation |
object |
No | Information about the receiving Wise entity, the owner of the bank account. |
load
GET /profiles/{profileId}/transfers/{transferId}/deposit-details/bank-transfer
Operation ID: payinDepositDetailGet.
Authentication: bearer token (UserToken).
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
profileId |
path |
integer (int64) |
Yes | Profile ID. |
transferId |
path |
integer (int64) |
Yes | Transfer ID. |
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: Payin deposit detail object
application/json
| Property | Type | Required | Description |
|---|---|---|---|
payinBank |
object |
No | Information about the receiving bank. |
payinBank.bankAddress |
object,null |
No | Bank address. |
payinBank.bankAddress.city |
string |
No | City. |
payinBank.bankAddress.country |
string |
No | Country ISO 2 code. |
payinBank.bankAddress.firstLine |
string |
No | Street address. |
payinBank.bankAddress.phone |
string,null |
No | Phone number. |
payinBank.bankAddress.postCode |
string |
No | Post code / zip code. |
payinBank.bankAddress.state |
string,null |
No | State. |
payinBank.bankName |
string |
No | Bank name. |
payinBankAccount |
object |
No | Bank account details to use to send the payment to. |
payinBankAccount.bankAccountType |
string |
No | The type of bank account to use for the payin, for example RECIPIENT, ESCROW, BALANCE, etc. |
payinBankAccount.currency |
string |
No | ISO 4217 source currency code. |
payinBankAccount.details |
array of object |
No | Account details. |
payinBankAccount.details[].description |
string |
No | Description of the account detail type. |
payinBankAccount.details[].formattedValue |
string,null |
No | Account details value, formatted according to the type of the field. Intended to be human-readable. This can be null. |
payinBankAccount.details[].label |
string |
No | Account details label that should be displayed in your user interface. |
payinBankAccount.details[].rawValue |
string |
No | Account details value, always unformatted. Can be used for processing. |
payinBankAccount.details[].type |
string |
No | Account details type, for example accountNumber, iban etc. |
payinBankAccount.details[].value |
string |
No | Account details value. This field is deprecated. Use rawValue and formattedValue instead. |
wiseInformation |
object |
No | Information about the receiving Wise entity, the owner of the bank account. |
wiseInformation.localAddress |
object,null |
No | Wise local address. |
wiseInformation.localAddress.city |
string |
No | City. |
wiseInformation.localAddress.country |
string |
No | Country ISO 2 code. |
wiseInformation.localAddress.firstLine |
string |
No | Street address. |
wiseInformation.localAddress.phone |
string,null |
No | Phone number. |
wiseInformation.localAddress.postCode |
string |
No | Post code / zip code. |
wiseInformation.localAddress.state |
string,null |
No | State. |
wiseInformation.localCompanyName |
string |
No | Wise local company name. |
429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header
application/json
The response is object.