Carteiras

Explore 3 endpoints de Carteiras, com finalidade, método e rota derivados do contrato publicado.

Endpoints relacionados

Abra um endpoint para consultar parâmetros, exemplos e respostas.

Quando usar cada endpoint

Compare a finalidade de cada operação antes de iniciar a integração.

EndpointFinalidade
GET/resource/walletsLista as carteiras da organização do token (e das suborganizações que ela enxerga). Use o id retornado como walletId nas operações Pix e o accPixOut como accountId na consulta ao DICT.
GET/resource/wallets/{walletId}Detalhe da carteira. accPixIn e accPixOut são as contas usadas no recebimento e no envio; accPixOut é o accountId exigido pela consulta ao DICT.
GET/resource/wallets/{walletId}/balanceDevolve o saldo por ativo da carteira. available é o que pode ser enviado agora; onHold está reservado para operações em andamento e blocked, bloqueado. Valores em reais.

Finalidades, métodos e rotas vêm do contrato OpenAPI publicado.

Fluxo da categoria

A ordem das chamadas, quem executa cada passo e o que vem depois. Clique numa chamada para ver o fluxo dela.

Da carteira ao Pix

  1. Chamada

    POSTEmitir token bearer

    /resource/auth/token

    Authorization: Bearer <seu-token>

  2. Chamada

    GETListar carteiras

    /resource/wallets

    Guarde o id: é o walletId

  3. Chamada

    GETConsultar carteira

    /resource/wallets/{walletId}

    accPixOut e organizationId

  4. Chamada

    GETConsultar saldo

    /resource/wallets/{walletId}/balance

    data.balances[].available, em reais

  5. Você

    Use o walletId nas operações Pix

    Cobrança, envio e relatórios