{
"id": "evt_9f8e7d6c-5b4a-4321-8fed-cba987654321",
"created_at": "2023-11-07T05:31:56Z",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"amount": 123,
"qr_code": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"qr_code_image": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"received_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_to_end_id": "<string>",
"payer": {
"name": "<string>",
"document": "***.456.789-**",
"bank": "Banco Exemplo S.A."
},
"metadata": {}
},
"attempts": 123
}API Reference
Evento enviado ao seu endpoint
Headers enviados em minúsculas. Assinatura HMAC-SHA256 do texto <t>.<corpo bruto> com o secret; durante a troca do secret (24 h) vêm dois v1=. Rejeite se t estiver a mais de 300 s do seu relógio. User-Agent: OriPay-Webhooks/1.0.
WEBHOOK
event
{
"id": "evt_9f8e7d6c-5b4a-4321-8fed-cba987654321",
"created_at": "2023-11-07T05:31:56Z",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"amount": 123,
"qr_code": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"qr_code_image": "<string>",
"paid_at": "2023-11-07T05:31:56Z",
"received_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"end_to_end_id": "<string>",
"payer": {
"name": "<string>",
"document": "***.456.789-**",
"bank": "Banco Exemplo S.A."
},
"metadata": {}
},
"attempts": 123
}Authorizations
Chave oripay_live_.... Só funciona dos IPs cadastrados para ela.
Headers
Example:
"t=1761656713,v1=5d41402a..."
Available options:
charge.paid, charge.expired, pix.received, transfer.completed, transfer.failed, transfer.returned, refund.completed, refund.failed, webhook.test Body
application/json
Example:
"evt_9f8e7d6c-5b4a-4321-8fed-cba987654321"
Available options:
charge.paid, charge.expired, pix.received, transfer.completed, transfer.failed, transfer.returned, refund.completed, refund.failed, webhook.test O recurso completo, no formato do GET, como estava quando o evento foi gerado. Em webhook.test, um objeto com message e sent_at
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Available options:
pending, delivered, failed Tentativas de entrega feitas
Response
200
Recebido