Create beneficiary

Endpoint for creating a new beneficiary.

Body Params

A ModelSerializer that takes additional arguments for
"fields", "omit" and "expand" in order to
control which fields are displayed, and whether to replace simple
values with complex, nested serializations

string
required

The full address of the beneficiary.

string
length ≤ 200

The name of the bank where the beneficiary account is held.

string
enum

The charge type of the account, indicating how fees are handled.

  • OUR - Ours
  • BEN - Beneficiary
  • SHA - Shared
Allowed:
contacts
array of strings

The contacts associated with the beneficiary. Can be multiple.

contacts
string
enum
required

ISO 3166 two-letter country code of the beneficiary bank account.

  • SA - Kingdom of Saudi Arabia
  • AE - United Arab Emirates
  • QA - Qatar
  • BH - Bahrain
  • KW - Kuwait
  • OM - Oman
  • EG - Egypt
  • US - United States of America
  • AF - Afghanistan
  • AX - Åland Islands
  • AL - Albania
  • DZ - Algeria
  • AS - American Samoa
  • AD - Andorra
  • AO - Angola
  • AI - Anguilla
  • AQ - Antarctica
  • AG - Antigua and Barbuda
  • AR - Argentina
  • AM - Armenia
  • AW - Aruba
  • AU - Australia
  • AT - Austria
  • AZ - Azerbaijan
  • BS - Bahamas (The)
  • BD - Bangladesh
  • BB - Barbados
  • BY - Belarus
  • BE - Belgium
  • BZ - Belize
  • BJ - Benin
  • BM - Bermuda
  • BT - Bhutan
  • BO - Bolivia
  • BQ - Bonaire, Sint Eustatius and Saba
  • BA - Bosnia and Herzegovina
  • BW - Botswana
  • BV - Bouvet Island
  • BR - Brazil
  • IO - British Indian Ocean Territory
  • BN - Brunei
  • BG - Bulgaria
  • BF - Burkina Faso
  • BI - Burundi
  • CV - Cabo Verde
  • KH - Cambodia
  • CM - Cameroon
  • CA - Canada
  • KY - Cayman Islands
  • CF - Central African Republic
  • TD - Chad
  • CL - Chile
  • CN - China
  • CX - Christmas Island
  • CC - Cocos (Keeling) Islands
  • CO - Colombia
  • KM - Comoros
  • CG - Congo
  • CK - Cook Islands
  • CR - Costa Rica
  • CI - Côte d'Ivoire
  • HR - Croatia
  • CU - Cuba
  • CW - Curaçao
  • CY - Cyprus
  • CZ - Czechia
  • CD - Democratic Republic of the Congo
  • DK - Denmark
  • DJ - Djibouti
  • DM - Dominica
  • DO - Dominican Republic
  • EC - Ecuador
  • SV - El Salvador
  • GQ - Equatorial Guinea
  • ER - Eritrea
  • EE - Estonia
  • SZ - Eswatini
  • ET - Ethiopia
  • FK - Falkland Islands (Malvinas)
  • FO - Faroe Islands
  • FJ - Fiji
  • FI - Finland
  • FR - France
  • GF - French Guiana
  • PF - French Polynesia
  • TF - French Southern Territories
  • GA - Gabon
  • GM - Gambia
  • GE - Georgia
  • DE - Germany
  • GH - Ghana
  • GI - Gibraltar
  • GR - Greece
  • GL - Greenland
  • GD - Grenada
  • GP - Guadeloupe
  • GU - Guam
  • GT - Guatemala
  • GG - Guernsey
  • GN - Guinea
  • GW - Guinea-Bissau
  • GY - Guyana
  • HT - Haiti
  • HM - Heard Island and McDonald Islands
  • HN - Honduras
  • HK - Hong Kong
  • HU - Hungary
  • IS - Iceland
  • IN - India
  • ID - Indonesia
  • IR - Iran
  • IQ - Iraq
  • IE - Ireland
  • IM - Isle of Man
  • IL - Israel
  • IT - Italy
  • JM - Jamaica
  • JP - Japan
  • JE - Jersey
  • JO - Jordan
  • KZ - Kazakhstan
  • KE - Kenya
  • KI - Kiribati
  • KG - Kyrgyzstan
  • LA - Laos
  • LV - Latvia
  • LB - Lebanon
  • LS - Lesotho
  • LR - Liberia
  • LY - Libya
  • LI - Liechtenstein
  • LT - Lithuania
  • LU - Luxembourg
  • MO - Macao
  • MG - Madagascar
  • MW - Malawi
  • MY - Malaysia
  • MV - Maldives
  • ML - Mali
  • MT - Malta
  • MH - Marshall Islands
  • MQ - Martinique
  • MR - Mauritania
  • MU - Mauritius
  • YT - Mayotte
  • MX - Mexico
  • FM - Micronesia
  • MD - Moldova
  • MC - Monaco
  • MN - Mongolia
  • ME - Montenegro
  • MS - Montserrat
  • MA - Morocco
  • MZ - Mozambique
  • MM - Myanmar
  • NA - Namibia
  • NR - Nauru
  • NP - Nepal
  • NL - Netherlands
  • NC - New Caledonia
  • NZ - New Zealand
  • NI - Nicaragua
  • NE - Niger
  • NG - Nigeria
  • NU - Niue
  • NF - Norfolk Island
  • KP - North Korea
  • MK - North Macedonia
  • MP - Northern Mariana Islands
  • NO - Norway
  • PK - Pakistan
  • PW - Palau
  • PS - Palestine
  • PA - Panama
  • PG - Papua New Guinea
  • PY - Paraguay
  • PE - Peru
  • PH - Philippines
  • PN - Pitcairn
  • PL - Poland
  • PT - Portugal
  • PR - Puerto Rico
  • RE - Réunion
  • RO - Romania
  • RU - Russia
  • RW - Rwanda
  • BL - Saint Barthélemy
  • SH - Saint Helena
  • KN - Saint Kitts and Nevis
  • LC - Saint Lucia
  • MF - Saint Martin (French part)
  • PM - Saint Pierre and Miquelon
  • VC - Saint Vincent and the Grenadines
  • WS - Samoa
  • SM - San Marino
  • ST - Sao Tome and Principe
  • SN - Senegal
  • RS - Serbia
  • SC - Seychelles
  • SL - Sierra Leone
  • SG - Singapore
  • SX - Sint Maarten (Dutch part)
  • SK - Slovakia
  • SI - Slovenia
  • SB - Solomon Islands
  • SO - Somalia
  • ZA - South Africa
  • GS - South Georgia
  • KR - South Korea
  • SS - South Sudan
  • ES - Spain
  • LK - Sri Lanka
  • SD - Sudan
  • SR - Suriname
  • SJ - Svalbard and Jan Mayen
  • SE - Sweden
  • CH - Switzerland
  • SY - Syria
  • TW - Taiwan
  • TJ - Tajikistan
  • TZ - Tanzania
  • TH - Thailand
  • TL - Timor-Leste
  • TG - Togo
  • TK - Tokelau
  • TO - Tonga
  • TT - Trinidad and Tobago
  • TN - Tunisia
  • TR - Türkiye
  • TM - Turkmenistan
  • TC - Turks and Caicos Islands
  • TV - Tuvalu
  • UG - Uganda
  • UA - Ukraine
  • GB - United Kingdom
  • UM - United States Minor Outlying Islands
  • UY - Uruguay
  • UZ - Uzbekistan
  • VU - Vanuatu
  • VA - Vatican City
  • VE - Venezuela
  • VN - Vietnam
  • VG - Virgin Islands (British)
  • VI - Virgin Islands (U.S.)
  • WF - Wallis and Futuna
  • EH - Western Sahara
  • YE - Yemen
  • ZM - Zambia
  • ZW - Zimbabwe
string
enum
required

The currency of the beneficiary bank account. Must be a valid currency code.

  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • AZN - AZN ман.
  • BAM - BAM KM
  • BDT - BDT ৳
  • BGN - BGN лв.
  • BHD - BHD د.ب.‏
  • BIF - BIF FBu
  • BND - BND $
  • BOB - BOB Bs
  • BRL - BRL R$
  • BWP - BWP P
  • BYN - BYN BYN
  • BZD - BZD $
  • CDF - CDF FrCD
  • CHF - CHF CHF
  • CLP - CLP $
  • CNY - CNY CN¥
  • COP - COP $
  • CRC - CRC ₡
  • CVE - CVE CV$
  • CZK - CZK Kč
  • DJF - DJF Fdj
  • DKK - DKK kr
  • DOP - DOP RD$
  • DZD - DZD د.ج.‏
  • EGP - EGP ج.م.‏
  • ERN - ERN Nfk
  • ETB - ETB Br
  • GBP - GBP £
  • GEL - GEL GEL
  • GHS - GHS GH₵
  • GNF - GNF FG
  • GTQ - GTQ Q
  • HKD - HKD $
  • HNL - HNL L
  • HRK - HRK kn
  • HUF - HUF Ft
  • IDR - IDR Rp
  • ILS - ILS ₪
  • INR - INR ₹
  • IQD - IQD د.ع.‏
  • IRR - IRR ﷼
  • ISK - ISK kr
  • JMD - JMD $
  • JOD - JOD د.أ.‏
  • JPY - JPY ¥
  • KES - KES Ksh
  • KHR - KHR ៛
  • KMF - KMF FC
  • KRW - KRW ₩
  • KWD - KWD د.ك.‏
  • KZT - KZT тңг.
  • LBP - LBP ل.ل.‏
  • LKR - LKR SL Re
  • LYD - LYD د.ل.‏
  • MAD - MAD د.م.‏
  • MDL - MDL MDL
  • MGA - MGA MGA
  • MKD - MKD MKD
  • MMK - MMK K
  • MOP - MOP MOP$
  • MUR - MUR MURs
  • MXN - MXN $
  • MYR - MYR RM
  • MZN - MZN MTn
  • NAD - NAD N$
  • NGN - NGN ₦
  • NIO - NIO C$
  • NOK - NOK kr
  • NPR - NPR नेरू
  • NZD - NZD $
  • OMR - OMR ر.ع.‏
  • PAB - PAB B/.
  • PEN - PEN S/.
  • PHP - PHP ₱
  • PKR - PKR ₨
  • PLN - PLN zł
  • PYG - PYG ₲
  • QAR - QAR ر.ق.‏
  • RON - RON RON
  • RSD - RSD дин.
  • RUB - RUB руб.
  • RWF - RWF FR
  • SDG - SDG SDG
  • SEK - SEK kr
  • SGD - SGD $
  • SOS - SOS Ssh
  • SYP - SYP ل.س.‏
  • THB - THB ฿
  • TND - TND د.ت.‏
  • TOP - TOP T$
  • TRY - TRY TL
  • TTD - TTD $
  • TWD - TWD NT$
  • TZS - TZS TSh
  • UAH - UAH ₴
  • UGX - UGX USh
  • UYU - UYU $
  • UZS - UZS UZS
  • VES - VES Bs.S.
  • VND - VND ₫
  • XAF - XAF FCFA
  • XOF - XOF CFA
  • YER - YER ر.ي.‏
  • ZAR - ZAR R
  • ZMW - ZMW ZK
string
required
length ≤ 34

The International Bank Account Number (IBAN) of the beneficiary account.

string
required

The name of the beneficiary. Must contain only Latin letters (A-Z), digits (0-9), and spaces.

string
length ≤ 11

The SWIFT code (BIC) of the beneficiary bank.

Headers
string

Client-provided UUID to uniquely identify a request

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json