Informações de Transação

Endpoint de Referência

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

---

Transaction Response Object

O objeto completo de resposta de transação inclui 3 estruturas internas importantes: transaction, payment e webhook:

1. o objeto payment contém os parâmetros da solicitação da própria transação, como o solicitante do pagamento e o recebedor informado.
2. o objeto transaction representa o registro completo da transação e contém informações sobre o fluxo da transação, os participantes (pagador e recebedor) e os resultados do processamento.
3. o objeto webhook contém informações sobre o endpoint para enviar as alterações de estado da transação.

Aqui está um exemplo de objeto de resposta:

{
    "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.paybrokers.solutions/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.paybrokers.solutions/QR/cob/224227163566832131468968987105612380081043125773316115079433PayBrokers Cobrança e Serviço em Tecnologia Ltda80993926086756031824***98A2E1EE",
            "qrCodeLocation": "https://api.sandbox.paybrokers.solutions/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"
        }
    }
}

A seguir, detalhamos cada um desses objetos, considerando seus nomes de campos, tipos, em quais estados de transação eles aparecem e em qual forma de pagamento também.

O Objeto Payment

O objeto fornece uma visão abrangente dos dados associados a uma solicitação de pagamento. Abrange detalhes essenciais, incluindo o valor da transação, timestamp de data e hora de criação e data de vencimento, bem como informações iniciais sobre o pagador e o recebedor. Como citado, o pagador é o solicitante do pagamento neste contexto.

❎

Participante Suprimido

Para transações Cash In, o destinatário é sempre PayBrokers e este objeto é suprimido.
Para Cash Out, onde a transação pagador é sempre PayBrokers, este objeto também é suprimido.

O Objeto Transaction

Conforme mencionado anteriormente, o objeto transaction mantém o conjunto completo referente ao seu ciclo de vida enquanto está sendo processado, conforme segue:

📅

Sobre formato de datas

Todas as datas são strings no formato ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ), como em 2023-07-04T02:33:50.690Z.

Os objetos aninhados pagador e recebedor (transaction.payer e transaction.recipient)

O objeto transaction também apresenta dois objetos aninhados: payer e recipient, e inclui informações sobre os participantes efetivos da transação. Os objetos cheios só serão preenchidos se a transação atingir um estado em que as informações processadas possam ser incluídas.

Esses campos também aparecem no objeto de pagamento, mas com semântica diferente. Lá, esses são os dados da solicitação da transação, na transação significam os participantes finais. Essa distinção se mostra significativa em cenários de PIX Cash In, onde o solicitante do pagamento e o executor do pagamento podem variar.

Por exemplo, imagine o João, um indivíduo que gera um QRCode PIX, e depois solicita à Maria que faça o pagamento em seu nome. Este é um pagamento completamente legal. Assim, enquanto João figuraria no objeto payment.payer (visto anteriormente), Maria estaria descrita no objeto transaction.payer, com os seguintes atributos.

✅

Informações sobre Participantes

Note que alguns campos só estão disponíveis se o Banco Adquirente disponibilizá-los.

O Objeto Webhook

Por fim, conforme mencionado anteriormente, o objeto interno do webhook apresenta informações de pagamento relacionadas às transições de estado das transações.