Skip to main content

Como usar a API listar as Subcontas de uma empresa via API?

info

Para a utilização desta funcionalidade é necessário possuir a funcionalidade Subconta

Para listar subcontas de uma empersa, você utiliza o endpoint /api/v1/subaccount da API.

Você pode acessar aqui a documentação referente a esse endpoint.

A empresa é identificada a partir do app_id usado no cabeçalho Authorization.

Após efetuar a requisição, se tudo ocorreu bem, o status code da requisição será 2xx e no body da resposta, uma lista das subcontas pertencentes a empresa além de detalhes de paginação:

Exemplos em código​

  curl 'https://api.openpix.com.br/api/v1/subaccount' -X GET \
      -H "Accept: application/json" \
      -H "Content-Type: application/json" \
      -H "user-agent: node-fetch" \
      -H "Authorization": "app_id"

Exemplos de resposta​

{
  "subAccounts": {
    "subaccount": {
      "name": "test-sub-account",
      "pixKey": "c4249323-b4ca-43f2-8139-8232aab09b93",
    }
  },
  "pageInfo": {
    "skip": 0,
    "limit": 10,
    "totalCount": 20,
    "hasPreviousPage": false,
    "hasNextPage": true
  }
}