PATCH
/
externalAccounts
/
{id}
Update an external bank account
curl --request PATCH \
  --url https://api.paygentic.io/v0/externalAccounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "status": "new",
  "metadata": {}
}'
{
  "id": "<string>",
  "object": "externalBankAccount",
  "organizationId": "<string>",
  "countryCode": "<string>",
  "bankName": "<string>",
  "currency": "<string>",
  "last4": "<string>",
  "accountHolderName": "<string>",
  "accountHolderType": "individual",
  "status": "new",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

External bank account ID

Body

application/json
accountHolderName
string
accountHolderType
enum<string>
Available options:
individual,
company
status
enum<string>
Available options:
new,
verified,
errored
metadata
object

Response

External bank account updated successfully

id
string
required

Unique identifier for the external bank account

object
enum<string>
required

Object type identifier

Available options:
externalBankAccount
organizationId
string
required

Unique identifier for an organization

countryCode
string
required

ISO 3166-1 alpha-2 country code

bankName
string
required

Name of the bank

currency
string
required

Currency code for the account

last4
string
required

Last 4 digits of the account number

accountHolderName
string
required

Name of the account holder

accountHolderType
enum<string>
required

Type of account holder

Available options:
individual,
company
status
enum<string>
required

Status of the external bank account

Available options:
new,
verified,
errored
createdAt
string<date-time>
required

Timestamp when the account was created

updatedAt
string<date-time>
required

Timestamp when the account was last updated

metadata
object

Additional metadata for the account