Developer Guide
Payment Events
Event Examples
2 min
{
"appId": "12345678",
"eventId": "1495468585434-0e73d1719173766fe4dfe1a8",
"eventType": "api",
"eventName": "payment_status_update",
"eventTime": "2021-05-21T08:30:00Z",
"payload": {
"id": "cfa45795-fe16-48e2-a372-130e30a72606", // paymentId
"consentId": "cfa45795-fe16-48e2-a372-130e30a72606",
"originalPaymentId": "cfa45795-fe16-48e2-a372-130e30a72678", // Required if is a retry payment
"clientRequestId": "1a3s2aebe29s2", // Requierd
"paymentMethod": "AUTOMATIC_PIX", // Required, INSTANT|AUTOMATIC_PIX
"amount": "1333.00", // Requierd
"currency": "BRL", // Requierd
"firstPayment": true, // Requierd if paymentMethod = AUTOMATIC_PIX
"status": "CONSENT_AUTHORIED", // Requierd
"statusUpdateAt": "2022-09-23T03:39:43Z", // Requierd
"statusReason": {
"code": "NAO_INFORMADO", // Requierd
"message": "Erro não informado na iniciadora ou detentora de conta." // Requierd
} // Optional
}
}The payment status( payload.status ) changes during the payment process are as Instant Payment .
{
"appId": "12345678", // Required
"eventId": "1495468585434-0e73d1719173766fe4dfe1a8", // Required
"eventType": "api", // Required
"eventName": "consent_status_update", // Required
"eventTime": "2021-05-21T08:30:00Z", // Required
"payload": {
"id": "cfa45795-fe16-48e2-a372-130e30a72606", // Requierd, consentId
"clientRequestId": "1a3s2aebe29s2", // Requierd
"status": "CONSENT_AUTHORIED", // Requierd
"paymentMethod": "AUTOMATIC_PIX", // Required, AUTOMATIC_PIX
"statusUpdateAt": "2022-09-23T03:39:43Z", // Requierd
"statusReason": {
"code": "NAO_INFORMADO",
"message": "Erro não informado na iniciadora ou detentora de conta."
} // Optional
} // Required, payload is raw map to payns
}
{
"appId": "12345678", // Required
"eventId": "1495468585434-0e73d1719173766fe4dfe1a8", // Required
"eventType": "api", // Required
"eventName": "payment_creation", // Required
"eventTime": "2021-05-21T08:30:00Z", // Required
"payload": {
"id": "cfa45795-fe16-48e2-a372-130e30a72606", // Requierd, paymentId
"consentId": "cfa45795-fe16-48e2-a372-130e30a72606", // Requierd
"originalPaymentId": "cfa45795-fe16-48e2-a372-130e30a72678", // Required if is a retry payment
"clientRequestId": "1a3s2aebe29s2", // Requierd
"paymentMethod": "AUTOMATIC_PIX", // Required, INSTANT|AUTOMATIC_PIX
"amount": "1333.00", // Requierd
"currency": "BRL", // Requierd
"firstPayment": true, // Requierd if paymentMethod = AUTOMATIC_PIX
"status": "CONSENT_AUTHORIED", // Requierd
"statusUpdateAt": "2022-09-23T03:39:43Z", // Requierd
"statusReason": {
"code": "NAO_INFORMADO", // Requierd
"message": "Erro não informado na iniciadora ou detentora de conta." // Requierd
} // Optional
}
}
{
"appId": "12345678", // Required
"eventId": "1495468585434-0e73d1719173766fe4dfe1a8", // Required
"eventType": "api", // Required
"eventName": "payment_retry", // Required
"eventTime": "2021-05-21T08:30:00Z", // Required
"payload": {
"id": "cfa45795-fe16-48e2-a372-130e30a72606", // Requierd, paymentId
"clientRequestId": "1a3s2aebe29s2", // Requierd
"originalPaymentId": "cfa45795-fe16-48e2-a372-130e30a72678", // Required if is a retry payment
"paymentMethod": "AUTOMATIC_PIX", // Required, INSTANT|AUTOMATIC_PIX
"amount": "1333.00", // Requierd
"currency": "BRL", // Requierd
"firstPayment": true, // Requierd if paymentMethod = AUTOMATIC_PIX
"status": "CONSENT_AUTHORIED", // Requierd
"statusUpdateAt": "2022-09-23T03:39:43Z", // Requierd
"statusReason": {
"code": "NAO_INFORMADO", // Requierd
"message": "Erro não informado na iniciadora ou detentora de conta." // Requierd
}, // Optional
"retryPaymentId": "cfa45795-fe16-48e2-a372-130e30a72606", // Requierd
}
}