Below is a breakdown of the fields that make up a transaction.
{
"id": "f1f3d35a-6ce5-4ebb-9a86-6fd3d8b262c2",
"payer": {
"name": "Jose Marcos",
"document": "12345678912"
},
"created_at": "2023-07-19T15:47:18.950595-03:00",
"reference": "",
"method": "PIX",
"value": 1,
"status": "FINISHED",
"currency": "USD",
"currency_to": "BRL",
"value_to_pay": 4.78,
"payment_identifier": "E544035632023053117100obQyCOFvaa",
"paid_at": "2023-07-19T18:47:46Z",
"ticket_reference": "80000001",
"reverted_at": null,
"cancellation_reason": {
"msg": "The CPF/CNPJ provided must be the same document as the payer. Expected document: ***.131.221-**, Payer document: ***.564.800-**. The funds will be returned automatically within a few moments.",
"error": "divergent.cpf_cnpj"
}
}
| Field | Description | Type | Note |
|---|---|---|---|
| id | Our internal ID | UUID | |
| payer | Payer's data | Object | The payer's name and document will be blank when the transaction is PENDING. |
| payer.name | Payer's name | String | |
| payer.document | Payer's document | String | When the document number is CPF, it will have 11 digits, when it is CNPJ, it will have 14 digits. |
| created_at | The time when the transaction was created | Datetime | |
| reference | Your internal reference | String | |
| method | Method type | Enum (PIX) | |
| value | Transaction value | Double | This value is in the original currency |
| status | Transaction status | Enum (Possible statuses) | |
| currency | Currency | Enum (Possible currencies) | |
| currency_to | Currency to pay | Enum (BRL) | BRL |
| value_to_pay | Transaction's value to user pay | Double | This value is in BRL |
| payment_identifier | Pix EndToEndId | String | Transaction identifier in the Pix system |
| paid_at | The time when the transaction was paid | Datetime | This value can be null. |
| ticket_reference | Internal reference for reconciliation | String | |
| reverted_at | The time when the transaction was reverted | Datetime | This value can be null. |
| cancellation_reason | Details related to canceling the order | Object | This value can be null, when the status is different from CANCELED. |
| cancellation_reason.error | Tag for identifying the error | String | |
| cancellation_reason.msg | Message for identifying the error | String | This error message will always be in English. |