Eventos de webhook
Corpo e headers de cada evento que a sua callbackUrl recebe, um por nome de evento.
x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*stringcharge*attempt*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "charge.paid", "charge": { "id": "string", "status": "string", "grossAmount": "string", "currency": "string", "externalReference": "string", "description": "string", "customer": { "name": "string", "email": "string", "document": "string", "phone": "string", "country": "string" }, "paymentMethod": { "type": "string", "brand": "string", "authorizationCode": "string", "expMonth": 0, "expYear": 0, "funding": "string", "last4": "string", "bankIspb": "string" }, "paidAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }, "attempt": { "id": "string", "paymentMethod": "string", "idempotencyKey": "string", "payer": { "name": "string", "email": "string", "document": "string", "phone": "string", "country": "string" } }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*stringcharge*refund*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "charge.refunded", "charge": { "id": "string", "status": "string", "grossAmount": "string", "refundedAmount": "string", "currency": "string" }, "refund": { "id": "string", "amount": "string", "status": "string" }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
A invoice, no mesmo formato da notificação legada do painel. Decida pelo
international_status; o status em português pode mudar.
id*integerid_transaction*stringtransaction_pix_id?string|nullexternal_reference?string|nullemv?string|nullamount*numberstatus*stringinternational_status*string"WAITING_PAYMENT""WAITING_PROCESSING""REVIEW_REQUIRED""PAYMENT_RECEIVED""PARTIALLY_PAID""PAYMENT_EXPIRED""PAYMENT_FAILED""WITHDRAWAL_IN_PROGRESS""WITHDRAWAL_IN_PROCESSING""WITHDRAWAL_COMPLETED""WITHDRAWAL_FAILED""REFUND_REQUESTED""BALANCE_REMOVED"name_client?string|nulldocument_client?string|nullcreatedAt?stringdate-time[key: string]?anyQualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
A invoice, no mesmo formato da notificação legada do painel. Decida pelo
international_status; o status em português pode mudar.
{ "id": 0, "id_transaction": "string", "amount": 0, "status": "string", "international_status": "WAITING_PAYMENT"}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
A invoice, no mesmo formato da notificação legada do painel. Decida pelo
international_status; o status em português pode mudar.
id*integerid_transaction*stringtransaction_pix_id?string|nullexternal_reference?string|nullemv?string|nullamount*numberstatus*stringinternational_status*string"WAITING_PAYMENT""WAITING_PROCESSING""REVIEW_REQUIRED""PAYMENT_RECEIVED""PARTIALLY_PAID""PAYMENT_EXPIRED""PAYMENT_FAILED""WITHDRAWAL_IN_PROGRESS""WITHDRAWAL_IN_PROCESSING""WITHDRAWAL_COMPLETED""WITHDRAWAL_FAILED""REFUND_REQUESTED""BALANCE_REMOVED"name_client?string|nulldocument_client?string|nullcreatedAt?stringdate-time[key: string]?anyQualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
A invoice, no mesmo formato da notificação legada do painel. Decida pelo
international_status; o status em português pode mudar.
{ "id": 0, "id_transaction": "string", "amount": 0, "status": "string", "international_status": "WAITING_PAYMENT"}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*string"payout.completed""payout.paid""payout.failed"payout*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "payout.completed", "payout": { "id": "string", "invoiceId": 0, "idempotencyKey": "string", "status": "completed", "grossAmount": 0, "netAmount": 0, "currency": "string", "type": "string", "destination": "string", "gateway": "string", "updatedAt": "2019-08-24T14:15:22Z" }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*string"payout.completed""payout.paid""payout.failed"payout*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "payout.completed", "payout": { "id": "string", "invoiceId": 0, "idempotencyKey": "string", "status": "completed", "grossAmount": 0, "netAmount": 0, "currency": "string", "type": "string", "destination": "string", "gateway": "string", "updatedAt": "2019-08-24T14:15:22Z" }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*string"payout.completed""payout.paid""payout.failed"payout*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "payout.completed", "payout": { "id": "string", "invoiceId": 0, "idempotencyKey": "string", "status": "completed", "grossAmount": 0, "netAmount": 0, "currency": "string", "type": "string", "destination": "string", "gateway": "string", "updatedAt": "2019-08-24T14:15:22Z" }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*stringautoPayout*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "auto_payout.skipped", "autoPayout": { "chargeId": "string", "status": "skipped", "reason": "string", "detail": "string", "config": { "kind": "string", "walletId": 0, "railway": "string", "percent": 0, "amount": 0 } }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
event*stringautoPayout*Qualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
{ "event": "auto_payout.failed", "autoPayout": { "id": "string", "chargeId": "string", "status": "failed", "reason": "string", "amount": 0, "currency": "string", "railway": "string", "walletId": 0, "attempts": 0, "urgent": true }}{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}x-Webhook-Signature*stringt=<segundos Unix>,v1=<HMAC-SHA256 em hex de t + "." + corpo>.
x-Webhook-Event-Id*stringId da entrega, o mesmo em todas as tentativas. Use para deduplicar.
x-Webhook-Event-Type*stringNome do evento.
x-Webhook-Timestamp*stringMomento da assinatura, em segundos Unix. Igual ao t da assinatura.
x-Webhook-Correlation-Id?stringId do recurso do evento (cobrança, invoice, saque ou pagamento em cripto).
application/json- body
O pagamento em cripto no status do evento.
[key: string]?anyQualquer 2xx confirma a entrega. Outro status ou timeout gera nova tentativa.
O pagamento em cripto no status do evento.
{ "x-Webhook-Signature": "string", "x-Webhook-Event-Id": "string", "x-Webhook-Event-Type": "string", "x-Webhook-Timestamp": "string"}Como receber, verificar a assinatura e deduplicar as entregas está no guia de Webhooks.