Skip to main content
PATCH
Update a bank account.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Path Parameters

id
string<uuid>
required

The bank account ID.

Body

Request model for updating a bank account.

bankAccountReference
null | string

The reference identifier associated with the bank account. Must be alphanumeric (letters, numbers, hyphens, underscores, and dots) and max 50 characters. Set to null to clear.

nickname
string

The new nickname for the bank account.

status
enum<string>

The new status for the bank account. Set to CLOSED to close the account.

Available options:
ACTIVE,
CLOSED

Response

Bank account updated successfully.

Response model for a bank account.

id
string<uuid>
required

Unique identifier for the bank account.

accountNumber
string
required

Masked account number.

createdDateTime
string<date-time>
required

The UTC timestamp when the bank account was created.

routingNumber
string
required

Bank routing number.

status
enum<string>
required

The status of the bank account.

Available options:
ACTIVE,
CLOSED
bankAccountReference
null | string

Reference identifier associated with the bank account.

nickname
null | string

Nickname for the bank account.