Configurar Webhook

Configure um webhook para receber notificacoes sobre o status das suas transferencias Pix.

O webhook de Cash Out notifica sobre os eventos TRANSFER_SETTLED (transferencia concluida com sucesso) e TRANSFER_CANCELLED (transferencia cancelada). Configure sua URL para receber esses eventos em tempo real.

POST/api/v2/webhooks/transfer

Configura ou atualiza a URL do webhook para receber notificacoes de transferencias Pix (Cash Out).

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2
`Content-Type`	application/json

Parametros do Body

Nome	Tipo	Obrigatorio	Descricao
`uri`	string	Obrigatorio	URL do webhook que recebera as notificacoes. Ex: https://sua-api.com/webhooks/transfer
`enabled`	boolean	Obrigatorio	Habilita (true) ou desabilita (false) o webhook
`headers`	object	Opcional	Headers customizados enviados nas notificacoes do webhook

Exemplo de Request

{
  "uri": "{{finance_base_url}}/webhooks/transfer",
  "enabled": true,
  "headers": {
    "X-Webhook-Secret": "your-secret-key"
  }
}

Exemplo de Response

{
  "id": "wh_transfer_abc123",
  "uri": "https://your-api.com/webhooks/transfer",
  "enabled": true,
  "headers": {
    "X-Webhook-Secret": "your-secret-key"
  },
  "createdAt": "2026-04-03T12:00:00Z"
}

Exemplos de Codigo

curl -X POST \
  https://pagamentos.basspago.com.br/api/v2/webhooks/transfer \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "uri": "https://your-api.com/webhooks/transfer",
    "enabled": true,
    "headers": {
      "X-Webhook-Secret": "your-secret-key"
    }
  }'