Get Pix In Transaction

GET

{{baseUrl}}/api/v1/transactions/pix-in

Retrieve a PIX IN transaction by id or externalRef.

Query params (at least one):

id: transaction id (UUID)

externalRef: client reference

Requires Basic Auth (secretKey:publicKey).

Requisição

Authorization

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros de Consulta

Respostas

🟢200

application/json

Body

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '{{baseUrl}}/api/v1/transactions/pix-in?id={{transactionId}}&externalRef=' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - 200 - Pix In Found

{
  "id": "bc06ccc9-c64f-4dc5-b54e-baabf08fbb1b",
  "amount": 10000,
  "type": "pix_in",
  "status": "paid",
  "refundedAmount": 0,
  "companyId": "4d1a3c25-2cfc-4f72-b814-23d9fd168c8e",
  "paymentMethod": "pix",
  "externalRef": "ORD-123",
  "postbackUrl": "https://webhook.example.com/postback",
  "ip": "::1",
  "createdAt": "2025-12-12T02:05:53.724Z",
  "updatedAt": "2025-12-12T02:06:10.724Z",
  "paidAt": "2025-12-12T02:06:08.000Z",
  "cancelledAt": null,
  "refundedAt": null,
  "customer": {
    "id": "e00d270d-84de-4b94-8d1b-3bb26921e04f",
    "name": "John Smith",
    "email": "john@email.com",
    "phone": "11999999999",
    "document": {
      "type": "cpf",
      "number": "12345678910"
    }
  },
  "pix": {
    "qrcode": "00020101021226880014br.gov.bcb.pix2566qrcode.example.com/pix/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "expiresAt": "2025-12-14T02:05:52.012Z",
    "endToEndId": "E18236120202512020455s14af098224",
    "payer": {
      "name": "Carlos Eduardo Santos",
      "document": "98765432100",
      "documentType": "cpf",
      "branch": "0001",
      "account": "123456",
      "bankName": "NUBANK",
      "bankIspb": "18236120"
    }
  },
  "refusedReason": null,
  "refusedCode": null,
  "refunds": [],
  "fee": {
    "total": 150,
    "net": 9850
  }
}

Modificado em 2025-12-29 21:29:45

Página anterior

Create Pix In Transaction

Próxima página

Pix Out