API Reference

Listando Transações por Order Id

Este endpoint permite recuperar as informações de transações pelo Order Id (Id da Plataforma)

Endpoint de Referência Endpoint

  • GET /accounts/transactions/pix

Parâmetros da Request (Examplo Útil)

/accounts/transactions/pix?transactionOrderId=c2782914-4d75-4fbb-8618-695a8d159316&startDate=2024-02-07T10:00:00.000Z&endDate=2024-02-08T10:00:00.000Z&dataset.limit=10&dataset.offset=0
Path ParamTypeRequiredDescription
transactionOrderIdstringtrueO transactionOrderId como especificado na criação da transação
startDatestringtrueO timestamp inicial para busca da transação
endDatestringtrueO timestamp inicial para busca da transação. O intervalo máximo deve ser de 1 dia.
dataset.limitnumbertrueO tamanho da paginação como um entre: 5, 10 or 20.
dataset.offsetnumbertrueO offset da paginação, começando de 0.

Object do Resposta da Transaction

{
    "statusCode": "Done",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 1,
        "items": [
          {
            "transaction": {
              "id": "4494a26c-4f21-400a-bbe7-cbef6ea7c3c2",
              "externalResourceId": "016c2d96-fb56-407a-b142-88ef29bee379",
              "orderId": "c2782914-4d75-4fbb-8618-695a8d159316",
              "orderDescription": "This is a test order.",
              "date": "2024-02-07T14:45:34.323Z",
              "stateRegisteredDate": "2024-02-07T14:45:34.332Z",
              "stateCompletedDate": "2024-02-07T14:45:39.150Z",
              "stateCancelledDate": null,
              "stateRefundDate": null,
              "stateReversedDate": null,
              "stateErrorDate": null,
              "stateErrorCause": null,
              "type": "Credit",
              "paymentType": "PIX",
              "category": "PartnerSales",
              "amount": "20.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-cbef6ea7c3c2/receipt.pdf",
              "receiptDate": "2024-02-07T14: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": "42393767956483436107br.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": "2024-02-07T14:45:39.227Z"
            }
          }
        }
      ]
    }   
}

📘

Detalhamento do Transaction Item

Neste ponto, você deve estar familiarizado com o objeto de transação, mas se não estiver, por favor verifique a seção anterior sobre o endpoint de Informação de Transação.