Skip to main content
PATCH
/
bank-accounts
/
{id}
Update a bank account
curl --request PATCH \
  --url https://api.artu.ai/bank-accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "data": {
    "accountNumber": "<string>",
    "bankName": "<string>",
    "bankCode": "<string>",
    "country": "<unknown>",
    "currency": "<string>",
    "isPrimary": true,
    "isActive": true,
    "label": "<string>",
    "externalId": "<string>",
    "metadata": {},
    "clabe": "<string>",
    "codigoBanco": "<string>",
    "codigoPlaza": "<string>"
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountNumber": "<string>",
  "bankName": "<string>",
  "country": "<unknown>",
  "currency": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "bankCode": "<string>",
  "type": "checking",
  "isPrimary": true,
  "isActive": true,
  "label": "<string>",
  "externalId": "<string>",
  "metadata": {},
  "clabe": "<unknown>",
  "codigoBanco": "<string>",
  "codigoPlaza": "<string>"
}

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

id
string<uuid>
required

Body

application/json
data
object
required

Response

200 - application/json

OK

id
string<uuid>
required
clientId
string<uuid>
required
accountNumber
string
required

Account Number

Minimum string length: 1
bankName
string
required

Bank Name

Minimum string length: 1
country
any
required
currency
string
required

Currency

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
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

externalId
string

External ID

metadata
object

Metadata

clabe
any

CLABE

codigoBanco
string

Bank Code

Required string length: 3
codigoPlaza
string

Plaza Code

Required string length: 3