PaymentDetails#Create
Create a Payment Detail
NB: For a list of what fields are required per currency, see Required Fields For Currencies.
Example Request
Endpoint Information
Create a Payment Detail
POST https://{{base_url}}/users/:user_id/payment_details
Path Parameters
user_id*
UUID
ID of the User which the Payment Detail belongs to.
String
Request Body
account_name*
String
A name to identify the bank account, e.g. 'Chris's Revolut'.
account_number
String
currency*
String
The currency that the bank account accepts. E.g. 'usd', 'eur'.
address_line1*
String
The first line of the address of the person or organisation that controls the bank account.
address_line2
String
The second line of the address of the person or organisation that controls the bank account.
city*
String
The city where the person or organisation that controls the bank account is located.
state
String
The state/district where the person or organisation that controls the bank account is located. Required if country is US
postal_code*
String
The postal/zip code where the person or organisation that controls the bank account is located.
country*
String
The country where the person or organisation that controls the bank account is located. Given in ISO 3166-1 alpha-2 format.
beneficiary_type*
String
individual or business
routing_number
String
bank_name*
String
The name of the bank associated with the account. e.g. 'Revolut'
sort_code
String
iban
String
swift_bic
String
document_number
String
account_type
String
rib_number
String
bsb_number
String
rails
String
ncc
String
branch_code
String
bank_code
String
date_of_birth*
String
The date of birth of the recipient. Required for individuals
ifsc
String
Our EUR (SEPA) provider does not support payments to the following countries:
[AE AF AS AO AI AG AW BS BD BB BZ BJ BO BW IO BN BF BI KH CM CV KY CF TD CX CC KM CG CD CK CU DJ DM DO EC GQ ER ET FJ PF TF GA GI GM GH GD GU GN GW GY HT HN IR IQ JM KI KP KG LA LB LS LR LY MG MW MV MI MH MR MU YT FM MN MS MZ MM NA NR NC NI NE NG NU NF MP PK PW PS PA PN PR RE RW BL SH KN PM VC WS ST SC SL SO GS SS SD SJ SY TJ TL TG TK TO TN TM TC TV UG UM VU VA VE VN VG VI WF EH YE ZM ZW]