Skip to main content
PUT
Create or update a bank account by external ID

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

externalId
string
required

External ID

Minimum string length: 1

Body

application/json
clientId
string<uuid>
required
accountNumber
string
required

Account Number

Minimum string length: 1
bankName
string
required

Bank Name

Minimum string length: 1
country
required

Country

currency
string
required

Currency

bankCode
string

Bank Code

type
enum<string>
default:checking

Type

Available options:
checking,
savings,
investment,
other
isPrimary
boolean

Is Primary

isActive
boolean

Is Active

label
string

Label

metadata
object

Metadata

clabe
string

CLABE

Minimum string length: 18
codigoBanco
string

Bank Code

Required string length: 3
codigoPlaza
string

Plaza Code

Required string length: 3

Response

200 - application/json

OK

data
object
required
action
enum<string>
required
Available options:
created,
updated,
skipped