Cash Out - Enviar Pix

Envie transferencias Pix, consulte saldo, acompanhe pagamentos e receba notificacoes via webhook.

Visao Geral

O modulo Cash Out permite que voce envie transferencias Pix diretamente da sua conta. Voce pode transferir usando uma chave Pix ou pagando um QR Code, consultar o saldo disponivel, acompanhar o status das transferencias e configurar webhooks para receber notificacoes em tempo real.

i

Base URL para todos os endpoints de Cash Out: https://pagamentos.basspago.com.br/api/v2

!

Os valores monetarios usam o objeto payment com amount em reais (decimais). Ex: { "currency": "BRL", "amount": 100.00 } = R$ 100,00. O header x-idempotency-key e obrigatorio em todos os endpoints de pagamento.

Fluxo de Integracao

1Obter Token de autenticacao (OAuth2)

2Consultar Saldo da conta

3Enviar Pix (por Chave Pix ou QR Code)

4Acompanhar a Transferencia

5Receber Notificacao via Webhook

Endpoints Disponiveis

GET/api/v2/accounts/balances

Consulta o saldo disponivel da sua conta.

POST/api/v2/pix/payments/dict

Envia um Pix usando uma chave Pix (CPF, CNPJ, EMAIL, PHONE, EVP).

POST/api/v2/pix/payments/qrc

Inicia um pagamento Pix via QR Code.

POST/api/v2/pix/payments/manu

Envia um Pix usando dados bancarios (ISPB, agencia, conta).

GET/api/v2/pix/payments/{endToEnd}

Consulta um Pix pelo endToEndId ou idempotencyKey.

GET/api/v2/pix/payments/idempotencyKey/{key}

Consulta os detalhes de uma transferencia pela idempotencyKey.

GET/api/v2/accounts/transactions

Lista e consulta transacoes da conta.

GET/api/v2/infractions

Lista, consulta e cria defesas para infracoes MED.

POST/api/v2/webhooks/transfer

Configura webhooks para transfer, receive, refund e cashout.