curl -X GET https://api.nixfypagamentos.com/api/transactions/01a1271c-a9a6-721f-938f-1bb03082bbb6 \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui"
{
"id": 12345,
"uuid": "01a1271c-a9a6-721f-938f-1bb03082bbb6",
"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": "joao@exemplo.com",
"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": {}
}
Transações
Buscar Transação
Recupere os detalhes de uma transação específica usando o uuid da venda
GET
/
api
/
transactions
/
{id}
curl -X GET https://api.nixfypagamentos.com/api/transactions/01a1271c-a9a6-721f-938f-1bb03082bbb6 \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui"
{
"id": 12345,
"uuid": "01a1271c-a9a6-721f-938f-1bb03082bbb6",
"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": "joao@exemplo.com",
"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": {}
}
Recupera os detalhes de uma transação específica usando o
uuid da venda (ou o id numérico, mantido para integrações antigas).
Autenticação
Este endpoint requer autenticação via API Keys:string
required
Sua chave pública da API
string
required
Sua chave privada da API
Parâmetros
string
required
uuid da venda (recomendado), como 01a1271c-a9a6-721f-938f-1bb03082bbb6. O id numérico também é aceito, para integrações antigas.Prefira o
uuid: ele é o identificador público da venda e não revela informação sequencial. O id numérico continua aceito e devolvido para não quebrar integrações existentes.Exemplo de Requisição
curl -X GET https://api.nixfypagamentos.com/api/transactions/01a1271c-a9a6-721f-938f-1bb03082bbb6 \
-H "X-Api-Public-Key: sua_chave_publica_aqui" \
-H "X-Api-Private-Key: sua_chave_privada_aqui"
Resposta de Sucesso
integer
ID numérico da venda (mantido para integrações antigas)
string
Identificador público da venda (UUID). Use este para consultar e referenciar a venda
string
Status atual da venda. Valores possíveis:
PENDENTE, PAGO, CANCELADO, RECUSADO, ESTORNADO, FALHA, EM_PROCESSAMENTO, CHARGEBACK, MEDnumber
Valor bruto em centavos
number
Valor líquido creditado em centavos
number
Taxas cobradas em centavos
number
Reserva financeira bloqueada em centavos
string
Método de pagamento. Valores possíveis:
CREDIT_CARD, DEBIT_CARD, BOLETO, PIX, TRANSFERstring
Data de criação da venda (ISO 8601)
string
Data de conclusão do pagamento (ISO 8601).
null se ainda não foi concluídoobject
Dados do cliente
string
Nome do cliente
string
Email do cliente
string
Documento do cliente
string
Telefone do cliente
array
Lista de itens da transação
integer
ID do item
string
Nome do produto
number
Preço unitário em centavos
integer
Quantidade
boolean
Se o item é físico ou digital
string
Chave PIX (apenas para PIX)
string
Últimos 4 dígitos do cartão (apenas para cartão)
string
Bandeira do cartão (apenas para cartão)
string
Código do boleto (apenas para boleto)
string
ID da transação no gateway de pagamento
integer
Número de parcelas (apenas para cartão de crédito)
object
Informações de entrega (apenas para produtos físicos)
Exemplo de Resposta
{
"id": 12345,
"uuid": "01a1271c-a9a6-721f-938f-1bb03082bbb6",
"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": "joao@exemplo.com",
"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 (nemuuid nem número).
{
"message": "ID inválido",
"error": "O ID da venda deve ser o uuid ou 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."
}