PayoutMethod-Request: Difference between revisions
Jump to navigation
Jump to search
Created page with "{{PageTitle|title=Payout method}} This structure represents a payout method associated with a recipient. == Included in == Payout methods are used in the following structures: * TODO == Property list == {{api_input_table_header}} |- | bankTransfer || Object || * Required || Bank transfer details object. |- | bankTransfer.accountNumber || String || * Required || The bank account number. Format depends on the <code>accountNumberFormat</code> property. |- | bankTransfe..." |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
Payout methods are used in the following structures: | Payout methods are used in the following structures: | ||
* | * [[Recipients-Post-v6|POST /v6/recipients]] | ||
* [[PayoutMethod-Post-v6|POST /v6/recipients/{recipientid}/payout-methods ]] | |||
== Property list == | == Property list == | ||
| Line 95: | Line 96: | ||
|| Last name of the account holder. | || Last name of the account holder. | ||
|- | |- | ||
|} | |}'''Additional length restrictions:''' | ||
Additional character limits apply to address fields depending on currency: | Additional character limits apply to address fields depending on currency: | ||
Latest revision as of 17:39, 28 May 2026
Payout method
This structure represents a payout method associated with a recipient.
Included in
Payout methods are used in the following structures:
Property list
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| bankTransfer | Object |
|
Bank transfer details object. |
| bankTransfer.accountNumber | String |
|
The bank account number. Format depends on the accountNumberFormat property.
|
| bankTransfer.accountNumberFormat | String |
|
Format of the account number. Accepted values:
|
| bankTransfer.bankAccountCountry | String |
|
Country of the bank account. Must be a valid ISO 3166-1 Alpha-3 code. |
| bankTransfer.currency | String |
|
Currency of the bank account. Accepted values:
|
| bankTransfer.bankSwiftCode | String |
|
SWIFT/BIC code of the bank. |
| bankTransfer.address | Object |
|
Address of the bank account holder. Not required for the following combinations:
|
| bankTransfer.address.country | String |
|
Country of the address. Must be a valid ISO 3166-1 Alpha-3 code. |
| bankTransfer.address.city | String |
|
City of the address. |
| bankTransfer.address.zip | String |
|
Postal code. |
| bankTransfer.address.street | String |
|
Street address. |
| bankTransfer.bankAccountHolderName | Object |
|
Name details of the bank account holder. |
| bankTransfer.bankAccountHolderName.nameType | String |
|
Type of the account holder. Accepted values: business or individual.
|
| bankTransfer.bankAccountHolderName.companyName | String |
|
Name of the company. |
| bankTransfer.bankAccountHolderName.firstName | String |
|
First name of the account holder. |
| bankTransfer.bankAccountHolderName.lastName | String |
|
Last name of the account holder. |
Additional length restrictions:
Additional character limits apply to address fields depending on currency:
- For
CZKcurrency:- Street: maximum 35 characters
- City: maximum 35 characters
- For
HUF,EUR, andUSDcurrencies:- Sum of Street, City, and Zip: maximum 54 characters