Skip to main content
PATCH

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payee_id
string<uuid>
required
bank_account_id
string<uuid>
required

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Body

application/json

Partial update for a saved payee bank account (PATCH semantics).

Only the fields included in the request body are changed; everything else is left untouched. The common use is filling in a corridor-required field that was missed at creation — e.g. the IFSC code for an India destination (bank_branch / ifsc). The account number, when supplied, is re-encrypted and re-masked exactly as on create.

nickname
string | null
Maximum string length: 120
account_holder_name
string | null
Maximum string length: 120
bank_name
string | null
Maximum string length: 120
account_type
string | null

Account type — "checking"/"savings" for US ACH, or the UniTeller code (AHO/CTE/NON).

Maximum string length: 30
bank_account_number
string | null

New bank account number (digits only). Re-encrypted on update.

Required string length: 4 - 34
bank_branch
string | null

UniTeller branch / routing code (IFSC, SWIFT/BIC, or CLABE).

Maximum string length: 50
bank_document
string | null
Maximum string length: 100
payout_branch_id
integer | null

Response

The updated bank account (sensitive numbers masked).

status_code
integer
required

HTTP status code for the response.

data
PayeeBankAccountRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.