Pular para o conteúdo principal
GET
/
credit-card
/
v1
/
payment
Listar Pagamentos
curl --request GET \
  --url https://api-gateway.firebanking.dev/credit-card/v1/payment \
  --header 'x-api-key: <api-key>'
{
  "payments": [
    {
      "id": "<string>",
      "status": "<string>",
      "amount": 123,
      "installments": 123,
      "externalId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "offset": 123,
  "limit": 123
}
Recuperar uma lista paginada de pagamentos da sua conta. Este endpoint suporta vários parâmetros de consulta para filtragem e paginação.

​
Parâmetros de Consulta

​
offset
integer
default:"0"
Número de itens a pular para paginação
​
limit
integer
default:"10"
Número máximo de itens a retornar (1-100)
​
count
boolean
default:"false"
Incluir contagem total na resposta para paginação

​
Estrutura da Resposta

A resposta inclui um array de objetos de pagamento com metadados de paginação quando count=true.

​
Exemplo de Requisição

cURL
curl -X GET "https://api-gateway.firebanking.com.br/credit-card/v1/payment?offset=0&limit=10&count=true" \
  -H "x-api-key: SUA_CHAVE_DE_API"

​
Exemplo de Resposta

Resposta
{
  "payments": [
    {
      "id": "payment-123",
      "status": "completed",
      "amount": 10000,
      "installments": 1,
      "externalId": "ext-payment-12345",
      "createdAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "payment-124",
      "status": "processing",
      "amount": 5000,
      "installments": 3,
      "externalId": "ext-payment-67890",
      "createdAt": "2024-01-15T11:15:00Z"
    }
  ],
  "total": 25,
  "offset": 0,
  "limit": 10
}
Use os parâmetros offset e limit para implementar paginação em sua aplicação.

Authorizations

​
x-api-key
string
header
required

Chave de API para autenticação

Query Parameters

​
offset
integer
default:0

Número de itens a pular

Intervalo obrigatório: x >= 0
​
limit
integer
default:10

Número máximo de itens a retornar

Intervalo obrigatório: 1 <= x <= 100
​
count
boolean
default:false

Incluir contagem total na resposta

Response

200 - application/json

Pagamentos recuperados com sucesso

​
payments
object[]
​
total
integer

Contagem total (se solicitada)

​
offset
integer

Offset atual

​
limit
integer

Limite atual