Create a new counterparty

post

https://sandbox.depasify.com/api/v1/accounts/{account_id}/bank_accounts/{bank_account_id}/counterparties

Creates a new counterparty for a specific bank account. A counterparty represents a recipient for fiat payments.

Country Requirements

All counterparties require base fields: iban, recipient, country, address_line1, city, postal_code, kind.
Depending on the recipient country, additional fields are required:

China (CN): supported_rails (e.g. ["CIPS"], ["SWIFT"]), institution_name, swift, state - United Arab Emirates (AE): supported_rails (e.g. ["UAEFTS00"], ["SWIFT"]), swift, state - Colombia (CO): institution_name, national_identification_number, phone_number, account_type (savings / checking), state - United States (US): routing_number, state (2-char ISO code), supported_rails, institution_name - Mexico (MX): state

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

string

required

bank_account_id

string

required

Body Params

Input schema for creating a counterparty. Base required fields: iban, recipient, country, address_line1, city, postal_code, kind. Additional required fields per country: - China (CN): supported_rails, institution_name, swift, state - UAE (AE): supported_rails, swift, state - Colombia (CO): institution_name, national_identification_number, phone_number, account_type, state - United States (US): routing_number, state, supported_rails, institution_name - Mexico (MX): state

iban

string

required

IBAN of the counterparty

amount

float

Defaults to 0

Amount associated with the counterparty

description

string

Description of the counterparty

recipient

string

required

Name of the recipient

alias

string

Alias for the counterparty (only used if favourite is true)

favourite

boolean

Whether to mark the counterparty as favourite

city

string

required

City of the counterparty

address_line1

string

required

First line of the address

country

string

required

length ≤ 2

^[A-Z]{2}$

Two-letter country code as defined in ISO 3166-1 alpha-2 standard (e.g., ES for Spain, US for United States).

postal_code

string

required

Postal code of the counterparty

currency

string

Defaults to EUR

Currency of the counterparty

kind

string

required

Type of counterparty

supported_rails

array of strings

Supported payment rails. ["FEDWIRE", "SWIFT", "ACH", "CIPS", "UAEFTS00"]. MANDATORY for USD, China (CN), and UAE (AE) counterparties.

supported_rails

institution_name

string

Name of the financial institution. MANDATORY for USD, CO, and China (CN) counterparties. Not required for MX. For Colombia (CO), must be one of: COINK SA, BANCO DE BOGOTA, BANCO POPULAR, BANCOLOMBIA, CITIBANK, BANCO GNB SUDAMERIS, BANCO BBVA, ITAÚ CORPBANCA COLOMBIA S.A, BANCO COLPATRIA (Scotiabank), BANCO DE OCCIDENTE, BANCOLDEX, BANCO CAJA SOCIAL, BANCO AGRARIO, BANCO DAVIVIENDA, AV VILLAS, BANCO PICHINCHA, BANCO COOMEVA, BANCO FALABELLA, BANCO SANTANDER DE NEGOCIOS COL., BANCO COOPERATIVO COOPCENTRAL, CONFIAR S.A., COLTEFINANCIERA S.A., NEQUI, BANCO W S.A., DAVIPLATA, LULO BANK, BANCO ITAÚ, BANCAMIA S.A., BANCO SERFINANZA, BANCO UNION, BANCIEN, BANCO JP MORGAN, IRIS, MOVII SA, DING TECNIPAGOS SA, POWWI, UALA, BANCO BTG PACTUAL COLOMBIA S.A., PIBANK, RAPPIPAY, BANCO MUNDO MUJER, GLOBAL66, NU, JFK Cooperativa Financiera, BOLD CF, Banco Contactar S.A.

routing_number

string

Routing number (for US accounts)

swift

string

SWIFT/BIC code. MANDATORY for China (CN) and UAE (AE) counterparties.

state

string

State or province. MANDATORY for US (2-char ISO 3166-2), CO, MX, China (CN), and UAE (AE) counterparties.

phone_number

string

Phone number with country code. MANDATORY for CO counterparties. Not required for MX.

national_identification_number

string

National identification number (Cédula/NIT). MANDATORY for CO counterparties. Not required for MX.

account_type

string

enum

Bank account type. MANDATORY for CO counterparties. Not required for MX.

Allowed:

relationship_to_customer

string

Relationship of the counterparty to the customer

date_of_birth

string

Date of birth (YYYY-MM-DD)

nationality

string

Two-letter nationality code

string

Email address of the counterparty

Response

201Counterparty created successfully