[GET] /payment/:id
Busca os detalhes de uma transação
Para saber mais
Consultar transaçãoO que muda nessa versão?
Na versão anterior, só era possível pesquisar pelo ID da transação gerado internamente. Agora, é possível buscar pelo
externalId
, que é o seu identificador enviado no momento da criação.Além disso, o resultado está bem mais rápido e mais enxuto, com informações claras.
Endpoint de produção
Método GET
Requisição
Headers
Campo |
Valor |
Tipo |
Descrição |
---|---|---|---|
Content-Type |
application/json |
string |
Define o conteúdo como JSON |
x-api-key |
123 |
string |
Sua chave API |
Parâmetros da rota
Campo |
Obrigatório |
Descrição |
---|---|---|
id |
Sim |
Identificador único da transação. Este campo pode ser tanto do tipo “id” (gerado internamente) quanto do tipo “externalId” (enviado no momento da criação do pagamento) |
cURL
curl --request GET \
--url https://api-gateway.firebanking.com.br/pix/v2/payment/<id> \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-api-key: <sua-chave-api>'
Exemplo de resposta
Campos a serem recebidos
Campo |
Tipo |
Descrição |
---|---|---|
id |
string |
Identificador da sua transação gerado internamente |
externalId |
string |
Identificador enviado por você no momento da criação do pagamento para referenciar o pagamento |
businessId |
string |
ID da sua conta |
endToEndId |
string |
E2E ou ID, é o identificador único de uma transação usando o método PIX |
operation.provider |
string |
Nome do seu provedor bancário |
operation.type |
string | enum |
Tipo da transação PAYMENT em caso de cash-in WITHDRAW em caso de cash-out |
operation.status |
string | enum |
Status da transação WAITING_PAYMENT WAITING_WITHDRAW WITHDRAW_PAID PAID REFUND_IN REFUND_OUT ERROR |
operation.value |
number |
Valor do pagamento |
operation.fee |
number |
Valor da taxa gerada sobre o pagamento |
operation.finalValue |
number |
Valor final a ser creditado ou debitado do saldo |
operation.refundValue |
number |
Valor que já foi reembolsado É utilizado em transações com status “REFUND_IN” |
operation.description |
string |
Descrição informada no momento da geração do pagamento |
operation.additionalInfo |
object |
Metadados enviados no momento da geração do pagamento |
negotiator.fullName |
string |
Nome do recebedor ou pagador |
negotiator.document |
string |
Documento (CPF/CNPJ) do recebedor ou pagador, fornecido no momento da |
payer |
Object | null |
Dados do pagador, em caso de cash-in |
payer.fullName |
string |
Nome do pagador fornecido pelo provedor bancário |
payer.document |
string |
Documento (CPF/CNPJ) do pagador fornecido pelo provedor bancário |
receiver |
Object | null |
Dados do recebedor, em caso de cash-out |
receiver.fullName |
string |
Nome do recebedor fornecido pelo provedor bancário |
receiver.document |
string |
Documento (CPF/CNPJ) do recebedor fornecido pelo provedor bancário |
WAITING_PAYMENT
JSON
{
"id": "997d58ca-bdfb-481d-93cd-7401e68cc0ea",
"externalId": "your-external-id",
"businessId": "6864503fed937a987efcc5f3",
"endToEndId": null,
"operation": {
"provider": "providerName",
"type": "PAYMENT",
"status": "WAITING_PAYMENT",
"value": 0.15,
"fee": 0.1,
"finalValue": 0.05,
"refundValue": 0,
"description": "Cobrança de teste",
"additionalInfo": {
"sellerId": "123",
"whatsAppPhone": "37988996655"
}
},
"negotiator": {
"fullName": "John Marvin",
"document": "***123667**"
},
"payer": null,
"receiver": null,
"createdAt": "2025-06-28T18:16:09.069Z",
"updatedAt": "2025-06-28T18:16:09.069Z"
}
PAID
JSON
{
"id": "997d58ca-bdfb-481d-93cd-7401e68cc0ea",
"externalId": "your-external-id",
"businessId": "6864503fed937a987efcc5f3",
"endToEndId": "E22896431202507012304VqlYVvBPxYp",
"endToEndId": null,
"operation": {
"provider": "providerName",
"type": "PAYMENT",
"status": "PAID",
"value": 0.15,
"fee": 0.1,
"finalValue": 0.05,
"refundValue": 0,
"description": "Cobrança de teste",
"additionalInfo": {
"sellerId": "123",
"whatsAppPhone": "37988996655"
}
},
"negotiator": {
"fullName": "John Marvin",
"document": "***123667**"
},
"payer": {
"fullName": "John Lenon",
"document": "***123667**"
},
"receiver": null,
"createdAt": "2025-06-28T18:16:09.069Z",
"updatedAt": "2025-06-28T18:16:09.069Z"
}
WITHDRAW_PAID
JSON
{
"id": "997d58ca-bdfb-481d-93cd-7401e68cc0ea",
"externalId": "your-external-id",
"businessId": "6864503fed937a987efcc5f3",
"endToEndId": "E22896431202507012304VqlYVvBPxYp",
"operation": {
"provider": "providerName",
"type": "WITHDRAW",
"status": "WITHDRAW_PAID",
"value": 0.15,
"fee": 0.1,
"finalValue": 0.25,
"refundValue": 0,
"description": "Cobrança de teste",
"additionalInfo": {
"sellerId": "123",
"whatsAppPhone": "37988996655"
}
},
"negotiator": {
"fullName": "John Marvin",
"document": "***123667**"
},
"payer": null,
"receiver": {
"name": "José Maria da Silva",
"document": "**********",
"bankName": "Banco C6 S.A.",
"pixKey": "12312312387",
"pixKeyType": "DOCUMENT"
},
"createdAt": "2025-06-28T18:16:09.069Z",
"updatedAt": "2025-06-28T18:16:09.069Z"
}