Reborn
Docs

Obter transação

gethttps://sandbox-api.rebornpay.io/v1/transactions/{id}Auth obrigatória

Retorna os dados completos de uma transação pelo seu UUID. Somente transações do seller autenticado são acessíveis.

Headers

X-Api-Keystringrequired

API Key do seller (header)

Path Parameters

idstringrequired

UUID da transação

Responses

200Dados da transação
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

401API Key ausente ou inválida
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

404Transação não encontrada
idstring · uuidrequired

UUID da transação

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

statusstring · enumrequired

Status atual

Example: PENDING

PENDINGPAIDFAILEDCANCELLEDREFUND_PENDINGREFUNDED
paymentMethodstring · enumrequired

Método de pagamento

Example: PIX

PIXCREDIT_CARDDEBIT_CARD
amountinteger · int64required

Valor em centavos

Example: 10000

currencystringrequired

Moeda (ISO 4217)

Example: BRL

descriptionstringoptional

Descrição da transação

Example: Pedido #1234

customerobjectoptional

Dados do pagador

namestringoptional

Nome do pagador

Example: João da Silva

emailstringoptional

E-mail do pagador

Example: joao@email.com

documentstringoptional

Documento mascarado

Example: 123.456.789-**

paymentDetailsobjectoptional

Detalhes do PIX gerado

qrCodestringoptional

Payload EMV (copia e cola)

Example: 00020126580014br.gov.bcb.pix...

qrCodeUrlstringoptional

URL da imagem do QR Code

Example: https://qrcode.example.com/...

expiresAtstring · date-timeoptional

Data/hora de expiração do QR Code (UTC)

createdAtstring · date-timerequired

Data/hora de criação (UTC)

updatedAtstring · date-timerequired

Data/hora da última atualização (UTC)

paidAtstring · date-timeoptional

Data/hora do pagamento confirmado (UTC). Nulo enquanto pendente.

refundsarrayrequired

Histórico de estornos da transação

idstring · uuidrequired

UUID do estorno

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amountinteger · int64required

Valor estornado nesta operação, em centavos

Example: 5000

originalAmountinteger · int64required

Valor original da transação no momento do estorno, em centavos

Example: 10000

statusstring · enumrequired

Status do estorno

Example: COMPLETED

PENDINGCOMPLETEDFAILED
requestedAtstring · date-timerequired

Data/hora da solicitação do estorno (UTC)

completedAtstring · date-timeoptional

Data/hora da confirmação do estorno (UTC). Nulo enquanto pendente.

idempotencyKeystringoptional

Chave de idempotência da criação (enviada no header ou gerada pelo servidor)

curl -X GET 'https://sandbox-api.rebornpay.io/v1/transactions/{id}' \  -H 'X-Api-Key: $API_KEY'
200Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING",
  "paymentMethod": "PIX",
  "amount": 10000,
  "currency": "BRL",
  "description": "Pedido #1234",
  "customer": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "document": "123.456.789-**"
  },
  "paymentDetails": {
    "qrCode": "00020126580014br.gov.bcb.pix...",
    "qrCodeUrl": "https://qrcode.example.com/...",
    "expiresAt": "2025-01-15T10:30:00Z"
  },
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-15T10:30:00Z",
  "paidAt": "2025-01-15T10:30:00Z",
  "refunds": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "amount": 5000,
      "originalAmount": 10000,
      "status": "COMPLETED",
      "requestedAt": "2025-01-15T10:30:00Z",
      "completedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "idempotencyKey": "string"
}