Webhooks

Receba notificações sobre atualizações de status.

A API PrimePay envia notificações (postbacks) para a URL configurada (postbackUrl) quando ocorrem atualizações de status nas transações.

Notificação de Depósito (Cash-in)

Notifica quando um depósito PIX é confirmado (PAID).

Payload

{
  "requestBody": {
    "transactionType": "RECEIVEPIX",
    "transactionId": "tx_123456789",
    "external_id": "seu_id_interno_123",
    "amount": 100.50,
    "paymentType": "PIX",
    "status": "PAID",
    "dateApproval": "2023-10-27T10:00:00.000Z"
  }
}

Notificação de Saque (Cash-out)

Saque Aprovado

Notifica quando um saque é aprovado/pago.

{
  "requestBody": {
    "transactionType": "PAYMENT",
    "transactionId": "out_123456789",
    "external_id": "pagamento_123",
    "amount": 50.00,
    "dateApproval": "2023-10-27T10:30:00.000Z",
    "statusCode": {
      "statusId": 1,
      "description": "Pagamento aprovado"
    }
  }
}

Saque Cancelado

Notifica quando um saque é cancelado ou rejeitado.

{
  "requestBody": {
    "transactionType": "PAYMENT",
    "transactionId": "out_123456789",
    "external_id": "pagamento_123",
    "amount": 50.00,
    "statusCode": {
      "statusId": 2,
      "description": "Pagamento cancelado"
    }
  }
}

A API espera uma resposta com status 200 do seu servidor para confirmar o recebimento do webhook. Caso contrário, poderá haver retentativas.