Get by id

Get by id

GET {{Environment_URL}}/mass-payments/v1/accounts/:id

This endpoint is designed to return the essential data required for managing a sub-account, including:

  • Full Banking Details: Necessary information for traditional bank transfers.

  • Pix Key: The exclusive key assigned to the sub-account for receiving funds.

  • Identification Name (name): The name or label defined during the sub-account creation process.

Headers

Name
Value

Authorization

Bearer <token>

Query Params

Name
Data Type
Description
Value

id

string

Subaccount Identifier

acc_01O88P082E1

Response

{
  "id": "acc-01...",
  "accountHolderName": "Internal Testing",
  "accountHash": "111111-222222-3333333-4",
  "accountPixAlias": "86142397-f9e8-4c51-a878-adccfc99172a",
  "taxNumber": "31625631000120",
  "bankInfo": {
    "bank": "450",
    "digit": "0",
    "branch": "0001",
    "account": "000000000"
  },
  "status": "ACTIVE"
}