[GET] /payment

Lista todas as cobranças geradas

Endpoints

Método GET

Sandbox (firebanking.dev)

https://api-gateway.firebanking.dev/credit-card/v1/payment

Produção (firebanking.com.br)

https://api-gateway.firebanking.com.br/credit-card/v1/payment

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
offset	Não	Número de registros para pular (usado para paginação)
limit	Não	Número máximo de registros por página
count	Não	Se deve retornar o total de registros na resposta

cURL

curl --request GET \
  --url 'https://api-gateway.firebanking.dev/credit-card/v1/payment?offset=0&limit=25&count=true' \
  --header 'x-api-key: <sua-chave-api>'

Exemplo de resposta

Campos a serem recebidos

{
	"metadata": {
		"resultset": {
			"count": 15,
			"offset": 0,
			"limit": 25
		}
	},
	"results": [
		{
			"id": "7e129a78-4cca-48f9-bfe4-f07622a373a6",
			"externalId": "38d25346-f14b-4a9a-82f4-ecef7840fcc3",
			"providerId": "84cde9f6-45ad-47a4-8236-addd11b55acc",
			"providerName": "barte",
			"status": "PAID",
			"value": 100.5,
			"installments": 1,
			"providerCustomerId": "12345678909",
			"customer": {
				"name": "João Silva",
				"document": "12345678909",
				"email": "[email protected]",
				"phone": "11999999999",
				"countryCode": "+55",
				"address": {
					"country": "BR",
					"state": "SP",
					"city": "São Paulo",
					"district": "Centro",
					"street": "Rua das Flores",
					"zipCode": "01234-567",
					"number": "123",
					"complement": "Apto 45"
				}
			},
			"additionalInfo": {
				"orderId": "internal-123321",
				"customerId": "cust-123321"
			},
			"title": "iPhone Pro Max 256GB",
			"description": "Smartphone Apple Pro Max",
			"callbackUrl": "https://webhook.site/abc123",
			"createdAt": "2025-07-31T05:54:20.170Z",
			"updatedAt": "2025-07-31T05:54:20.170Z"
		}
	]
}