Create a new counterparty

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
string
required
Body Params
string
required

IBAN of the counterparty

float
Defaults to 0

Amount associated with the counterparty

string

Description of the counterparty

string
required

Name of the recipient

string

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

boolean

Whether to mark the counterparty as favourite

string

City of the counterparty

string

First line of the address

string
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).

string

Postal code of the counterparty

string
Defaults to EUR

Currency of the counterparty

string
required

Type of counterparty

supported_rails
array of strings

Supported payment rails. ["FEDWIRE", "SWIFT", "ACH"] MANDATORY IF USD

supported_rails
string

Name of the financial institution. MANDATORY for USD and CO 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.

string

Routing number (for US accounts)

string

SWIFT/BIC code

string

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

string

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

string

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

string
enum

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

Allowed:
string

Relationship of the counterparty to the customer

string

Date of birth (YYYY-MM-DD)

string

Two-letter nationality code

string

Email address of the counterparty

Response

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