Consultar Pix

Consulte os detalhes de um pagamento Pix pelo identificador end-to-end ou pela chave de idempotencia.

O endToEnd e o identificador unico gerado pelo sistema de pagamentos instantaneos (SPI) do Banco Central. Ele e retornado na resposta da criacao do pagamento apos o processamento.

Voce tambem pode consultar um pagamento pela chave de idempotencia (x-idempotency-key) enviada na criacao. Isso e util quando voce ainda nao possui o endToEnd.

GET/api/v2/pix/payments/{endToEnd}

Consulta os detalhes de um pagamento Pix pelo identificador end-to-end.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`endToEnd`	string	Identificador end-to-end do pagamento Pix

Exemplo de Response

{
  "id": "pay_abc123def456",
  "endToEnd": "E0000000020260408T1030abc123def45",
  "status": "COMPLETED",
  "priority": "HIGH",
  "paymentFlow": "INSTANT",
  "payment": {
    "currency": "BRL",
    "amount": 100.00
  },
  "description": "Payment for services",
  "idempotencyKey": "unique-key-123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-04-08T10: 30:00Z",
  "completedAt": "2026-04-08T10: 30:02Z"
}

Exemplos de Codigo

curl -X GET \
  https://pagamentos.basspago.com.br/api/v2/pix/payments/E0000000020260408T1030abc123def45 \
  -H 'Authorization: Bearer {access_token}'

GET/api/v2/pix/payments/idempotencyKey/{idempotencyKey}

Consulta os detalhes de um pagamento Pix pela chave de idempotencia utilizada na criacao.

Base URL: https://pagamentos.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2

Parametros de Rota

Nome	Tipo	Descricao
`idempotencyKey`	string	Chave de idempotencia enviada no header x-idempotency-key durante a criacao do pagamento

Exemplo de Response

{
  "id": "pay_abc123def456",
  "endToEnd": "E0000000020260408T1030abc123def45",
  "status": "COMPLETED",
  "priority": "HIGH",
  "paymentFlow": "INSTANT",
  "payment": {
    "currency": "BRL",
    "amount": 100.00
  },
  "description": "Payment for services",
  "idempotencyKey": "unique-key-123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-04-08T10: 30:00Z",
  "completedAt": "2026-04-08T10: 30:02Z"
}

Exemplos de Codigo

curl -X GET \
  https://pagamentos.basspago.com.br/api/v2/pix/payments/idempotencyKey/unique-key-123e4567-e89b-12d3-a456-426614174000 \
  -H 'Authorization: Bearer {access_token}'