Skip to main content
Webhooks são a melhor maneira de manter seu sistema sincronizado com as atualizações de pagamento e saques. Sempre que o status de uma transação mudar, nosso sistema enviará uma requisição POST para a URL cadastrada.

​
Payins (Pagamentos)

Enviamos um JSON no corpo da requisição contendo os detalhes do evento de pagamento. 
{
  "event": "PAYMENT_STATUS_CHANGED",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "externalId": "tx_987654321",
    "referenceId": "pedido_12345",
    "status": "APPROVED",
    "amount": 10050,
    "paymentMethod": "PIX",
    "processedAt": "2023-10-27T10:05:00Z"
  }
}

​
Campos do Payload (Payin)

​
event
string
O tipo do evento (ex: PAYMENT_STATUS_CHANGED).
​
data
object
O objeto contendo os dados atualizados da transação.

​
Payouts (Saques)

Enviamos um JSON com os detalhes da atualização do saque. 
{
  "id": "a1b2c3d4-...",
  "externalId": "tx_citrex_98765...",
  "status": "APPROVED",
  "amount": 5000,
  "referenceId": "ref_123456"
}

​
Campos do Payload (Payout)

​
id
string
O ID interno do saque.
​
externalId
string
ID da transação no processador bancário.
​
status
string
Novo status da transação.
​
amount
integer
Valor em centavos.
​
referenceId
string
Seu ID de referência enviado na criação.

​
Status Possíveis (Payout)

StatusDescrição
PENDINGO pagamento foi criado e está sendo processado pelo banco.
APPROVEDO pagamento foi confirmado e o dinheiro enviado.
FAILEDO pagamento falhou ou foi rejeitado. O saldo é estornado automaticamente.

​
Resposta Esperada

Seu servidor deve responder com um status HTTP 200 OK para confirmar o recebimento do webhook. Caso contrário, nosso sistema tentará reenviar a notificação.