← Back to Account Payouts docs
← Back to Parties docs
| Available | Coming Soon |
targetCurrency | Must be null |
countryCode | Beneficiary's country of their residential (if payee is an individual) or registered (if payee is a company) address. Enter the 2 character ISO 3166-1 standard country code in your API request. |
| Earliest Beneficiary Credit | real-time |
| Cut-Off Time (UK Time) | N/A |
| Decimal Places | 2 |
Minimum targetAmount | 5 |
Maximum targetAmount | 9999999.99 |
| API field name | Required? | Field length | Description |
|---|---|---|---|
channel | ✅ | N/A | Blockchain name. Available values:
|
expandableKeyValuePairs.tag | ❌ | object or null | Identifier on the blockchain level that some exchanges use to identify users. |
beneficiaryWalletDetails.walletIdentifierType | ✅ | N/A | Must be:
|
beneficiaryWalletDetails.walletIdentifier | ✅ | 1-64 | Beneficiary wallet address on the selected blockchain. |
parties.partyType | ✅ | N/A | Type of the party. Must be:
|
parties.personalDetails.type | ✅ | N/A | Entity description code for the party. Available values:
|
parties.personalDetails.title | Conditional | N/A | Title code for the individual. Available values:
Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.firstName | Conditional | Max 50 | Beneficiary first name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.middleName | ❌ | Max 50 | Beneficiary middle name. |
parties.personalDetails.lastName | Conditional | Max 50 | Beneficiary last name. Full name should be provided (no initials). Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.companyName | Conditional | Max 140 | Full name of the organization. Important Failure to provide the full name could result in delays and potential rejection of your payment. This must consist of 2 words, separated by a space. To whitelist any other naming format please contact your Relationship Manager. Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.dateOfBirth | Conditional | 10 | Beneficiary's date of birth in YYYY-MM-DD format. Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.dateOfIncorporation | ❌ | 10 | A company's date of incorporation in YYYY-MM-DD format. |
parties.identityDocuments.type | Conditional | N/A | Beneficiary's identity type. Available values:
Condition Mandatory if parties.personalDetails.type is:
|
parties.identityDocuments.number | Conditional | 1-35 | Beneficiary's Company Registration Number. Condition Mandatory if parties.personalDetails.type is:
|
parties.identityDocuments.issuingCountry | Conditional | 2 | Beneficiary's country code of their identification document. Enter the 2 character ISO 3166-1 standard country code in your API request. Condition Mandatory if parties.personalDetails.type is:
|
parties.personalDetails.email | Strongly recommended | Max 50 | Beneficiary's email address. |
parties.personalDetails.phones.number | Strongly recommended | 5-20 | Phone number of the beneficiary. |
parties.personalDetails.phones.prefix | Strongly recommended | 1-3 | Phone country dialing code of the beneficiary. |
parties.address.address1 | Strongly recommended | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) house number/name and street e.g. 1 Main Street. |
parties.address.address2 | ❌ | Max 35 | Beneficiary's residential (if payee is an individual) or registered (if payee is a company) address e.g. apartment no., unit, studio. |
parties.address.city | Strongly recommended | Max 35 | Beneficiary's city or town of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.state | Conditional | Max 35 | Beneficiary's state code of residential address (if payee is an individual) or registered address (if payee is a company). Condition Mandatory if countryCode is:
|
parties.address.postalCode | ❌ | 5-9 | Beneficiary's postal code or zip code of their residential (if payee is an individual) or registered (if payee is a company) address. |
parties.address.countryCode | Strongly recommended | 2 | Beneficiary's country of their residential (if payee is an individual) or registered (if payee is a company) address. Enter the 2 character ISO 3166-1 standard country code in your API request. |
Important
Additional data is required if the requestor of the payout is a Payment Service Provider (PSP) or Money Service Business (MSB).
| Region code | Region name |
|---|---|
| UA-43 | Autonomous Republic of Crimea |
| UA-71 | Cherkasy region |
| UA-74 | Chernihiv region |
| UA-77 | Chernivtsi region |
| UA-12 | Dnipropetrovsk region |
| UA-14 | Donetsk region |
| UA-26 | Ivano-Frankivsk region |
| UA-65 | Kherson region |
| UA-63 | Kharkiv region |
| UA-68 | Khmelnytskyi region |
| UA-35 | Kirovohrad region |
| UA-30 | Kyiv City |
| UA-32 | Kyiv region |
| UA-09 | Luhansk region |
| UA-46 | Lviv region |
| UA-48 | Mykolaiv region |
| UA-51 | Odesa region |
| UA-53 | Poltava region |
| UA-56 | Rivne region |
| UA-40 | Sevastopol City |
| UA-59 | Sumy region |
| UA-61 | Ternopil region |
| UA-21 | Transcarpathia region |
| UA-05 | Vinnytsia region |
| UA-07 | Volyn region |
| UA-23 | Zaporizhzhia region |
| UA-18 | Zhytomyr region |