Pular para o conteúdo principal
GET
/
credit-card
/
v1
/
payment
/
{paymentId}
Obter Pagamento por ID
curl --request GET \
  --url https://api-gateway.firebanking.dev/credit-card/v1/payment/{paymentId} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "status": "<string>",
  "amount": 123,
  "installments": 123,
  "externalId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}
Recuperar informações detalhadas sobre um pagamento específico usando seu identificador único.

​
Parâmetros de Caminho

​
paymentId
string
required
O identificador único do pagamento a ser recuperado

​
Exemplo de Requisição

cURL
curl -X GET "https://api-gateway.firebanking.com.br/credit-card/v1/payment/payment-123" \
  -H "x-api-key: SUA_CHAVE_DE_API"

​
Exemplo de Resposta

Resposta
{
  "id": "payment-123",
  "status": "completed",
  "amount": 10000,
  "installments": 1,
  "externalId": "ext-payment-12345",
  "purchaseTitle": "Compra de Produto",
  "description": "Descrição da compra",
  "chargeType": "FEE_TO_CUSTOMER",
  "captured": true,
  "buyer": {
    "uuid": "buyer-uuid-12345",
    "name": "João da Silva",
    "email": "[email protected]",
    "document": "25201246010"
  },
  "maskedCardNumber": "****-****-****-1111",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:31:00Z"
}

​
Valores de Status de Pagamento

  • pending: Pagamento está sendo processado
  • completed: Pagamento foi bem-sucedido
  • failed: Pagamento falhou
  • cancelled: Pagamento foi cancelado
  • refunded: Pagamento foi estornado
Use este endpoint para verificar o status atual de um pagamento e recuperar detalhes completos do pagamento.

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação

Path Parameters

​
paymentId
string
required

ID do pagamento

Response

200 - application/json

Pagamento recuperado com sucesso

​
id
string

ID do pagamento

​
status
string

Status do pagamento

​
amount
integer

Valor do pagamento em reais

​
installments
integer

Número de parcelas

​
externalId
string

ID de referência externa

​
createdAt
string<date-time>

Timestamp de criação