GET
/
api
/
v1
/
gateway
/
consult-transaction
curl --request GET \
  --url https://sandbox.ws.relaxpay.site/api/v1/gateway/consult-transaction \
  --header 'ci: <ci>' \
  --header 'cs: <cs>'
{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "status": "PAID",
  "amount": 100,
  "paidAt": "2024-12-15T14:30:45.000Z",
  "response": "OK"
}

Acompanhe o status das suas transações PIX em tempo real com este endpoint.

​
Visão Geral

O endpoint de verificação de status permite consultar a situação atual de um pagamento PIX. Esta é uma forma prática de integrar o status dos pagamentos diretamente ao seu sistema.

​
Endpoint

​
Parâmetros

​
idTransaction
string
required

ID da transação PIX a ser consultada

​
Exemplos de Requisição

​
Resposta de Sucesso

​
200 - OK
object
{
  "idTransaction": "0b935d10-3c90-4af3-8776-dd18622a7941",
  "status": "PAID",
  "amount": 100.00,
  "paidAt": "2024-12-15T14:30:45Z",
  "response": "OK"
}

​
Status Possíveis

PENDING

Pagamento aguardando confirmação

EXPIRED

QR Code expirado sem pagamento

CANCELLED

Pagamento cancelado

PAID

Pagamento confirmado

REFUNDED

Pagamento reembolsado

​
Códigos de Erro

​
Boas Práticas

1

Implementar polling com intervalo

Consulte periodicamente o status de transações pendentes, mas respeite os limites de requisições.

2

Utilizar webhooks

Implemente webhooks para receber atualizações automáticas e reduzir a necessidade de consultas.

3

Armazenar status

Armazene o status em seu sistema para histórico e evite consultas desnecessárias.

4

Implementar retry com backoff

Em caso de falhas temporárias, implemente um mecanismo de retry com tempos crescentes.

Respeite o limite de 100 consultas por minuto para evitar bloqueios temporários.

​
Exemplo de Implementação

Headers

​
ci
string
required

Client ID para autenticação

​
cs
string
required

Client Secret para autenticação

Query Parameters

​
idTransaction
string
required

ID da transação PIX

Response

200
application/json
Status do pagamento
​
idTransaction
string

ID da transação PIX

Example:

"0b935d10-3c90-4af3-8776-dd18622a7941"

​
status
enum<string>

Status do pagamento

Available options:
PENDING,
PAID,
EXPIRED,
CANCELLED,
REFUNDED
Example:

"PAID"

​
amount
number

Valor do pagamento

Example:

100

​
paidAt
string

Data e hora do pagamento

Example:

"2024-12-15T14:30:45.000Z"

​
response
string

Status da resposta

Example:

"OK"