Consultar Pagamento

🔍 Consulta de Pagamento

Retorna os detalhes completos de uma transação existente, incluindo status atual, dados do cliente, informações de pagamento e produtos. Headers Obrigatórios:

Authorization: Bearer {API_KEY}

📋 Parâmetros

transactionId

string

required

ID único da transação (UUID). Retornado na criação do pagamento.

📤 Resposta

transactionId

string

ID único da transação

status

string

Status atual da transação: initial, pending, approved, declined, refund, chargeback, expired, paid, cancelled

amount

string

Valor da transação (ex: “150.00”)

currency

string

Moeda da transação (sempre “BRL”)

paymentMethod

string

Método de pagamento: PIX, BOLETO ou CREDIT_CARD

customer

object

Dados do cliente

customer.name

string

Nome do cliente

customer.email

string

E-mail do cliente

customer.document

string

CPF/CNPJ do cliente

customer.phone

string

Telefone do cliente

pix

object

Dados do PIX (presente quando paymentMethod = PIX, null caso contrário)

pix.qrCode

string

URL da imagem do QR Code PIX

pix.code

string

Código PIX copia e cola

boleto

object

Dados do boleto (presente quando paymentMethod = BOLETO, null caso contrário)

boleto.code

string

Código de barras do boleto

boleto.url

string

URL do boleto para visualização/download

products

array

Produtos associados à transação

products[].id

string

ID do produto

products[].name

string

Nome do produto

products[].quantity

integer

Quantidade

products[].price

string

Preço unitário

products[].total

number

Valor total do item

utm

object

Dados de rastreamento UTM

utm.source

string

UTM Source

utm.medium

string

UTM Medium

utm.campaign

string

UTM Campaign

utm.term

string

UTM Term

utm.content

string

UTM Content

createdAt

string

Data e hora de criação da transação (ISO 8601)

paidAt

string

Data e hora de confirmação do pagamento (ISO 8601, null se não pago)

refundedAt

string

Data e hora do estorno (ISO 8601, null se não estornado)

chargebackAt

string

Data e hora do chargeback (ISO 8601, null se não houve chargeback)

📤 Exemplo de Resposta

Pagamento PIX Pendente

{
  "transactionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "pending",
  "amount": "150.00",
  "currency": "BRL",
  "paymentMethod": "PIX",
  "customer": {
    "name": "João Silva",
    "email": "joao@email.com",
    "document": "12345678901",
    "phone": "11999999999"
  },
  "pix": {
    "qrCode": "https://api.provider.com/qr/image/a1b2c3d4-example.png",
    "code": "00020101021226810014br.gov.bcb.pix2559example.com/qr/v2/cob/a1b2c3d4520400005303986540515.005802BR5905LOJA16009Sao_Paulo62290525abc123def456ghi789jkl0mn6304ABCD"
  },
  "boleto": null,
  "products": [
    {
      "id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
      "name": "Curso de Marketing Digital",
      "quantity": 1,
      "price": "150.00",
      "total": 150
    }
  ],
  "utm": {
    "source": "google",
    "medium": "cpc",
    "campaign": "lancamento",
    "term": null,
    "content": null
  },
  "createdAt": "2026-03-06T14:30:00.000Z",
  "paidAt": null,
  "refundedAt": null,
  "chargebackAt": null
}

Pagamento Aprovado

{
  "transactionId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "paid",
  "amount": "299.90",
  "currency": "BRL",
  "paymentMethod": "CREDIT_CARD",
  "customer": {
    "name": "Maria Santos",
    "email": "maria@email.com",
    "document": "98765432100",
    "phone": "21988888888"
  },
  "pix": null,
  "boleto": null,
  "products": [
    {
      "id": "d4e5f6a7-b8c9-0123-defg-h12345678901",
      "name": "Plano Premium Anual",
      "quantity": 1,
      "price": "299.90",
      "total": 299.9
    }
  ],
  "utm": {
    "source": null,
    "medium": null,
    "campaign": null,
    "term": null,
    "content": null
  },
  "createdAt": "2026-03-05T10:00:00.000Z",
  "paidAt": "2026-03-05T10:00:15.000Z",
  "refundedAt": null,
  "chargebackAt": null
}

💡 Exemplo Prático

curl -X GET https://api-v2.orbitapay.com.br/pay/payments/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer sua-api-key"

⚠️ Erros Comuns

Transação não encontrada

{
  "error": "Not Found",
  "message": "Transaction not found",
  "statusCode": 404
}

API Key inválida

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "statusCode": 401
}

Authorizations

Authorization

string

header

required

API_KEY gerada dentro da plataforma em https://app-v2.orbitapay.com.br/apps

Path Parameters

transactionId

string<uuid>

required

ID único da transação (UUID)

Response

Detalhes do pagamento

transactionId

string<uuid>

ID único da transação

status

enum<string>

Status atual da transação

Available options:

initial,

pending,

approved,

declined,

refund,

chargeback,

expired,

paid,

cancelled

amount

string

Valor da transação (ex: "2430.00")

currency

enum<string>

Moeda da transação

Available options:

BRL

paymentMethod

enum<string>

Método de pagamento utilizado

Available options:

PIX,

BOLETO,

CREDIT_CARD

customer

object

Dados do cliente

Show child attributes

pix

object

Dados do PIX (presente quando paymentMethod = PIX)

Show child attributes

boleto

object

Dados do boleto (presente quando paymentMethod = BOLETO)

Show child attributes

products

object[]

Produtos associados à transação

Show child attributes

utm

object

Dados de rastreamento UTM

Show child attributes

createdAt

string<date-time>

Data e hora de criação da transação

paidAt

string<date-time> | null

Data e hora de confirmação do pagamento

refundedAt

string<date-time> | null

Data e hora do estorno

chargebackAt

string<date-time> | null

Data e hora do chargeback

Documentação da API

Endpoints

🔍 Consulta de Pagamento

📋 Parâmetros

📤 Resposta

📤 Exemplo de Resposta

Pagamento PIX Pendente

Pagamento Aprovado

💡 Exemplo Prático

⚠️ Erros Comuns

Transação não encontrada

API Key inválida

Authorizations

Path Parameters

Response

Documentação da API

Endpoints

​🔍 Consulta de Pagamento

​📋 Parâmetros

​📤 Resposta

​📤 Exemplo de Resposta

​Pagamento PIX Pendente

​Pagamento Aprovado

​💡 Exemplo Prático

​⚠️ Erros Comuns

​Transação não encontrada

​API Key inválida

Authorizations

Path Parameters

Response

🔍 Consulta de Pagamento

📋 Parâmetros

📤 Resposta

📤 Exemplo de Resposta

Pagamento PIX Pendente

Pagamento Aprovado

💡 Exemplo Prático

⚠️ Erros Comuns

Transação não encontrada

API Key inválida