Listar Cobranças
Permite que você recupere uma lista de todas as cobranças criadas.
curl --request GET \
--url https://api.abacatepay.com/v1/billing/list \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "bill_123456",
"url": "https://pay.abacatepay.com/bill-5678",
"amount": 4000,
"status": "PENDING",
"devMode": true,
"methods": [
"PIX"
],
"products": [
{
"id": "prod_123456",
"externalId": "prod-1234",
"quantity": 2
}
],
"frequency": "ONE_TIME",
"nextBilling": null,
"customer": {
"id": "bill_123456",
"metadata": {
"name": "Daniel Lima",
"cellphone": "(11) 4002-8922",
"email": "daniel_lima@abacatepay.com",
"taxId": "123.456.789-01"
}
}
}
],
"error": "<any>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Lista de cobranças criadas.
Identificador único da cobrança.
"bill_123456"
URL onde o usuário pode concluir o pagamento.
"https://pay.abacatepay.com/bill-5678"
Valor total a ser pago em centavos.
4000
Status atual da cobrança.
PENDING, EXPIRED, CANCELLED, PAID, REFUNDED "PENDING"
Indica se a cobrança foi criada em ambiente de testes.
true
Métodos de pagamento suportados para esta cobrança.
PIX ["PIX"]
Frequência da cobrança.
ONE_TIME, MULTIPLE_PAYMENTS "ONE_TIME"
Data e hora da próxima cobrança, ou null para cobranças únicas.
null
Os dados do seu cliente.
Identificador único do cliente
"bill_123456"
Dados do cliente
Nome completo do seu cliente
"Daniel Lima"
Celular do cliente
"(11) 4002-8922"
E-mail do cliente
"daniel_lima@abacatepay.com"
CPF ou CNPJ do cliente.
"123.456.789-01"
curl --request GET \
--url https://api.abacatepay.com/v1/billing/list \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "bill_123456",
"url": "https://pay.abacatepay.com/bill-5678",
"amount": 4000,
"status": "PENDING",
"devMode": true,
"methods": [
"PIX"
],
"products": [
{
"id": "prod_123456",
"externalId": "prod-1234",
"quantity": 2
}
],
"frequency": "ONE_TIME",
"nextBilling": null,
"customer": {
"id": "bill_123456",
"metadata": {
"name": "Daniel Lima",
"cellphone": "(11) 4002-8922",
"email": "daniel_lima@abacatepay.com",
"taxId": "123.456.789-01"
}
}
}
],
"error": "<any>"
}