PayoutMethod-Response: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{PageTitle|title=Payout method}} | {{PageTitle|title=Payout method}} | ||
This structure represents a payout method associated with a recipient. | This structure represents a payout method associated with a recipient ***in a response***. | ||
== Included in == | == Included in == | ||
Revision as of 17:35, 28 May 2026
Payout method
This structure represents a payout method associated with a recipient ***in a response***.
Included in
Payout methods are used in the following structures:
- TODO
Property list
| Property name | Property type | Description |
|---|---|---|
| id | String | Unique identifier of the payout method. Format: pout_<ordered-base64-ulid>.
|
| methodType | String | Type of the payout method. Currently only bank_transfer.
|
| bankTransfer | Object | Present if methodType is bank_transfer.
|
| 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.bankAccountCurrency | String | Currency of the bank account. Length: 3 characters. Accepted values:
|
| bankTransfer.bankSwiftCode | String | SWIFT/BIC code of the bank. Length: 8–11 characters. null if accountNumberFormat is not iban.
|
| bankTransfer.isDeleted | bool | Indicates whether the payout method has been deleted. |
| 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. Maximum length: 16 characters. |
| 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. Only present if nameType is business.
|
| bankTransfer.bankAccountHolderName.firstName | String | First name of the account holder. Only present if nameType is individual.
|
| bankTransfer.bankAccountHolderName.lastName | String | Last name of the account holder. Only present if nameType is individual.
|