Create a counterparty
/counterpartiesSave a counterparty to pay: a bank account (ACH, instant or wire), an account at this bank (book transfer), a bank abroad named by BIC with an IBAN or account number (international wire), or an address (a mailed check)
Headers
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
account_numberstringOptionalaccount_typestringOptionalChecking (default), savings, general_ledger or loan
addressobject or nullOptionalPostalAddress is a counterparty's mailing address.
6 child attributes
citystringRequiredcountry_codestringRequiredline_1stringRequiredline_2stringOptionalpostal_codestringOptionalstatestringOptionalbank_namestringOptionalRequired to wire
bicstringOptionalThe counterparty's bank abroad; giving it pays the counterparty by international wire
customer_idstringRequiredExample cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm
descriptionstringOptionalemailstringOptionalibanstringOptionalThe international account number, on a counterparty paid by international wire
legal_idstringOptionallegal_typestringOptionalBusiness, non_profit, individual or sole_proprietor
namestringRequiredpay_bystringOptionalAch (default with a routing number), book (an account at this bank), realtime, wire, international_wire (default with a BIC) or check (no routing number)
phonestringOptionalrouting_numberstringOptionalrouting_number_typestringOptionalAba
Returns
201 Created
The Counterparty object.
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503