Subcontas

Listar subcontas

Lista as subcontas associadas à sua master account, com o saldo atual de cada uma.

GET/v1/accounts/subaccounts

Base URL Produção:https://api.validapay.com.br

Base URL Sandbox:https://sandbox.validapay.com.br

A paginação é por cursor: a primeira página dispensa nextPageToken; para as seguintes, envie o nextPageToken devolvido na resposta anterior. Sem ele, a API recusa page maior que 1. Enquanto hasMore for true, ainda há páginas.

Authorizations

bearer

Authorization

string obrigatório

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

subaccounts/read

Query Parameters

pageopcional

Página desejada, a partir de 1. Acima de 1, envie também nextPageToken

perPageopcional

Subcontas por página, de 1 a 100 (padrão 15)

nextPageTokenopcional

Cursor devolvido na resposta anterior. Exigido quando page for maior que 1

← Anterior

Status de subconta

Listar cobranças

const url = 'https://sandbox.validapay.com.br/v1/accounts/subaccounts?page=1&perPage=15';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200▾

JSON

{
    "masterAccountId": "SANDBOX_0438f4c8-0031-7051-16d4-5a23704756b6",
    "subAccounts": [
        {
            "documentNumber": "66677788830",
            "createdAt": "2026-02-23T22:29:52.537Z",
            "accountNumber": "4960589",
            "status": "CONFIRMED",
            "onboardingId": "b9790268-a770-4aec-8fe5-d891f17e8007",
            "name": "Friedrich Nietzsche",
            "dailyWithdrawalLimit": 3000,
            "balance": 0,
            "withdrawalPixKey": null
        },
        {
            "documentNumber": "33344455508",
            "createdAt": "2026-02-17T20:38:45.664Z",
            "accountNumber": "4949228",
            "status": "CONFIRMED",
            "onboardingId": "30608b18-7258-437d-a6cb-63e5882e4fb7",
            "name": "Tales de Mileto",
            "dailyWithdrawalLimit": 3000,
            "balance": 170.9,
            "withdrawalPixKey": null
        }
    ],
    "page": 1,
    "perPage": 15,
    "hasMore": false,
    "dateFrom": "2026-02-01T00:00:00.000Z",
    "dateTo": "2026-02-23T23:59:59.999Z",
    "nextPageToken": "eyJhY2NvdW50TnVtYmVyIjoiNDk0OTIyOCJ9"
}

← Anterior

Status de subconta

Listar cobranças