Skip to main content
PATCH
/
embedded-banking
/
v1
/
bank-accounts
/
{id}
Update a bank account.
curl --request PATCH \
  --url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "status": "ACTIVE"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountNumber": "<string>",
  "createdDateTime": "2023-11-07T05:31:56Z",
  "routingNumber": "<string>",
  "status": "ACTIVE",
  "nickname": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

The bank account ID.

Body

Request model for updating a bank account.

nickname
null | string

The new nickname for the bank account.

status
null | 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
nickname
null | string

Nickname for the bank account.