Transaction Information

Reference Endpoint

• GET /accounts/transactions/pix/{transactionId}

Transaction Response Object

The full transaction response object includes 3 important inner structures: transaction, payment and webhook:

1. the payment object contains the request parameters for the transaction itself, such as the payment requestor and the informed recipient.
2. the transaction inner object represents the full transaction record, and contains information about the transaction flow, the participants (payer and recipient), and the processing results.
3. the webhook object contains information about the endpoint for sending the transaction state changes.

Here is a response object example:

{
    "statusCode": "Done",
    "data": {
        "transaction": {
            "id": "4494a26c-4f21-400a-bbe7-cbef6ea7c3c3",
            "externalResourceId": "016c2d96-fb56-407a-b142-88ef29bee379",
            "orderId": "in-1414870875-158709817091784",
            "orderDescription": "This is a test order.",
            "date": "2023-08-04T14:45:34.323Z",
            "stateRegisteredDate": "2023-08-04T14:45:34.332Z",
            "stateCompletedDate": "2023-08-04T14:45:39.150Z",
            "stateCancelledDate": null,
            "stateRefundDate": null,
            "stateReversedDate": null,
            "stateErrorDate": null,
            "stateErrorCause": null,
            "type": "Credit",
            "paymentType": "PIX",
            "category": "PartnerSales",
            "amount": "50.000000",
            "currency": "BRL",
            "state": "Completed",
            "charges": "0.000000",
            "chargesObject": {
                "costValue": "0",
                "rateValue": "0",
                "rate": "0.00"
            },
            "receiptUrl": "https://api.sandbox.pagfast.com/v1/system/e-receipt/4494a26c-4f21-400a-bbe7-cbef6ea7c3c3/receipt.pdf",
            "receiptDate": "2023-08-04T14:45:39.047Z",
            "receiptVoucher": "D6BE9C802C7846029269C485FE23060C",
            "receiptAmount": "50.000000",
            "metadata": {},
            "payer": {
                "name": "CRISTINA INACIO OLIVEIRA DA CONCEICAO",
                "taxNumber": "14435549603",
                "bankCode": "999",
                "bankName": null,
                "accountAgency": "99999",
                "accountNumber": "99999",
                "accountDigit": "9"
            },
            "customerName": "Test Customer",
            "accountName": "1",
            "accountNumber": "6212790001"
        },
        "payment": {
            "value": {
                "original": "50.000000"
            },
            "qrCode": "02393767956483436107br.gov.bcb.pix2564qrcode.sandbox.pagfast.com.br/QR/cob/224227163566832131468968987105612380081043125773316115079433Pagfast Cobranca e Servic6014Campina Grande80993926086756031824***98A2E1EE",
            "qrCodeLocation": "https://api.sandbox.pagfast.com/v1/system/qrcodeviewer/4494a26c-4f21-400a-bbe7-cbef6ea7c3c3",
            "payer": {
                "name": "CRISTINA INACIO OLIVEIRA DA CONCEICAO",
                "cpf": "14435549603",
                "cnpj": null
            }
        },
        "webhook": {
            "url": "https://postman-echo.com/post?test=1",
            "customHeaderName": "Authorization",
            "customHeaderValue": "eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyJ1aWQiOiI2YTZjYjY2NC03NzI4LTR",
            "deliveryStatus": "Sent",
            "deliveryTime": "2023-08-04T14:45:39.227Z"
        }
    }
}

Next, we detail each of these objects, considering it's fields names, types, in which transaction states they appear and in which payment method too.

The Inner Payment Object

The Payment Object provides a comprehensive view of the data associated with a payment request. It encompasses essential details, including the transaction value, creation timestamp, and expiration date, as well as initial information about both the payer and recipient. Notably, the payer is the payment requestor in this context.

❎

Supressed Participant

For Cash In transactions the recipient is always PagFast, and this object is supressed.
For Cash Out, where the transaction payer is always PagFast, this object is also supressed.

The Inner Transaction Object

As mentioned before, the transaction object represents the current state of a transaction, regarding it's lifecycle, while they are being processed, as follows:

📅

About dates format

All dates are strings in the ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ), as for 2023-07-04T02:33:50.690Z.

The payer and recipient nested objects (transaction.payer and transaction.recipient)

The transaction object also presents two nested objects: payer and recipient, and includes information about the effective transaction participants. The full objects will only be filled if the transaction reaches a state where processed information can be included.

These fields also appear in the payment object but with different semantics. There, these are the transaction request information, meanwhile in the transaction they mean the final participants. This distinction proves significant in PIX Cash In scenarios, where the payment requestor and payment executor may vary.

For instance, envision John, an individual who generate a PIX QRCode, and then requests Mary to execute the payment on his behalf. This is a completely legal payment. So, while John would figure in the payment.payer object (seen before), Mary would be described in the transaction.payer object, with the following attributes.

✅

Information about Participants

Some of these fields were marked as (if available). That means they will only be filled if the Acquiring Bank provides them.

The Inner Webhook Object

Finally, as mentinoned earlier, the webhook inner object presents payment information regarding the transactions state transitions.