Skip to main content

​
Buscar Transação

Recupera os detalhes de uma transação específica usando o ID da venda.

​
Autenticação

Este endpoint requer autenticação via API Keys:
​
X-Api-Public-Key
string
required
Sua chave pública da API
​
X-Api-Private-Key
string
required
Sua chave privada da API

​
Parâmetros

​
id
integer
required
ID da venda (Sale ID)

​
Exemplo de Requisição

curl -X GET https://api.nextpagamentos.io/api/transactions/12345 \
  -H "X-Api-Public-Key: nxpay_63cd5cf695f26414f92eb9a500059460" \
  -H "X-Api-Private-Key: nxpay_399c0e9cd8bdae9b586bc814dc88b8df36b50b537630c9d17b5a96e1e45e7f99"

​
Resposta de Sucesso

​
id
integer
ID da venda
​
status
string
Status atual da venda. Valores possíveis: PENDENTE, PAGO, CANCELADO, RECUSADO, ESTORNADO, FALHA, EM_PROCESSAMENTO, CHARGEBACK, MED
​
amount
number
Valor bruto em centavos
​
netAmount
number
Valor líquido creditado em centavos
​
systemFee
number
Taxas cobradas em centavos
​
reserveAmount
number
Reserva financeira bloqueada em centavos
​
paymentMethod
string
Método de pagamento. Valores possíveis: CREDIT_CARD, DEBIT_CARD, BOLETO, PIX, TRANSFER
​
date
string
Data de criação da venda (ISO 8601)
​
completedAt
string
Data de conclusão do pagamento (ISO 8601). null se ainda não foi concluído
​
customer
object
Dados do cliente
​
customer.name
string
Nome do cliente
​
customer.email
string
Email do cliente
​
customer.document
string
Documento do cliente
​
customer.phone
string
Telefone do cliente
​
items
array
Lista de itens da transação
​
items[].id
integer
ID do item
​
items[].title
string
Nome do produto
​
items[].unitPrice
number
Preço unitário em centavos
​
items[].quantity
integer
Quantidade
​
items[].tangible
boolean
Se o item é físico ou digital
​
pixKey
string
Chave PIX (apenas para PIX)
​
cardLastFour
string
Últimos 4 dígitos do cartão (apenas para cartão)
​
cardBrand
string
Bandeira do cartão (apenas para cartão)
​
boletoCode
string
Código do boleto (apenas para boleto)
​
externalTransactionId
string
ID da transação no gateway de pagamento
​
installments
integer
Número de parcelas (apenas para cartão de crédito)
​
shipping
object
Informações de entrega (apenas para produtos físicos)

​
Exemplo de Resposta

{
  "id": 12345,
  "status": "PAGO",
  "amount": 10000,
  "netAmount": 9500,
  "systemFee": 500,
  "reserveAmount": 0,
  "paymentMethod": "CREDIT_CARD",
  "date": "2024-01-15T10:30:00.000Z",
  "completedAt": "2024-01-15T10:31:00.000Z",
  "customer": {
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone": "11999999999"
  },
  "items": [
    {
      "id": 1,
      "title": "Produto de Teste",
      "unitPrice": 10000,
      "quantity": 1,
      "tangible": false
    }
  ],
  "pixKey": null,
  "cardLastFour": "1234",
  "cardBrand": "VISA",
  "boletoCode": null,
  "externalTransactionId": "ext_123456",
  "installments": 1,
  "shipping": {}
}

​
Códigos de Erro

​
400 Bad Request

ID inválido. 
{
  "message": "ID inválido",
  "error": "O ID da transação deve ser um número válido"
}

​
401 Unauthorized

Não autorizado - Chaves de API inválidas ou ausentes. 
{
  "message": "Não autorizado",
  "error": "Chaves de API inválidas ou ausentes"
}

​
403 Forbidden

Acesso negado - Venda não pertence ao usuário autenticado. 
{
  "message": "Acesso negado",
  "error": "Esta transação não pertence à sua conta"
}

​
404 Not Found

Venda não encontrada. 
{
  "message": "Transação não encontrada",
  "error": "A transação com o ID informado não existe"
}

​
500 Internal Server Error

Erro interno do servidor. 
{
  "message": "Erro interno do servidor",
  "error": "Falha ao buscar transação. Tente novamente mais tarde."
}