Get Pix Out Transaction

GET

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

Retrieve a PIX OUT transaction by id, externalRef, or idempotencyKey.

Query params (at least one):

id: transaction id (UUID)

externalRef: client reference

idempotencyKey: idempotency key used on creation

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-out?id={{transactionId}}&externalRef=&idempotencyKey=' \
--header 'Authorization: Basic <encoded-value>'

Response Example

200 - 200 - Pix Out Found

{
  "id": "f4b25725-5c90-485f-962d-aad7210b4f6a",
  "amount": 10000,
  "type": "pix_out",
  "status": "paid",
  "refundedAmount": 0,
  "companyId": "4d1a3c25-2cfc-4f72-b814-23d9fd168c8e",
  "paymentMethod": "pix",
  "externalRef": "withdraw_123",
  "postbackUrl": "https://webhook.example.com/postback",
  "ip": "::1",
  "createdAt": "2025-12-12T00:41:31.170Z",
  "updatedAt": "2025-12-12T00:41:41.976Z",
  "paidAt": "2025-12-12T00:41:41.955Z",
  "cancelledAt": null,
  "refundedAt": null,
  "customer": null,
  "pix": {
    "endToEndId": "E04838403202512120041TS55EAFN3YS",
    "destination": {
      "pixKey": "maria.santos@example.com",
      "pixKeyType": "EMAIL",
      "name": "Maria Santos",
      "document": "98765432100"
    },
    "requiresManualApproval": false,
    "beneficiary": {
      "name": "MARIA SANTOS OLIVEIRA",
      "document": "98765432100",
      "documentType": "cpf",
      "branch": "0001",
      "account": "123456",
      "bankName": "ITAÚ",
      "bankIspb": "60701190"
    }
  },
  "refusedReason": null,
  "refusedCode": null,
  "refunds": [],
  "fee": {
    "total": 60,
    "net": 9940
  }
}

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

Página anterior

Create Pix Out Transaction

Próxima página

Webhooks (Reference)