Listar cobranças - AbacatePay

GET

billing

list

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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Lista de cobranças retornada com sucesso.

data

object[]

Lista de cobranças criadas.

data.id

string

required

Identificador único da cobrança.

Example:

"bill_123456"

data.url

string

required

URL onde o usuário pode concluir o pagamento.

Example:

"https://pay.abacatepay.com/bill-5678"

data.amount

number

required

Valor total a ser pago em centavos.

Example:

4000

data.status

enum<string>

required

Status atual da cobrança.

Available options:

PENDING,

EXPIRED,

CANCELLED,

PAID,

REFUNDED

Example:

"PENDING"

data.devMode

boolean

required

Indica se a cobrança foi criada em ambiente de testes.

Example:

true

data.methods

enum<string>[]

required

Métodos de pagamento suportados para esta cobrança.

Available options:

PIX

Example:

["PIX"]

data.products

object[]

required

Lista de produtos na cobrança.

data.frequency

enum<string>

required

Frequência da cobrança.

Available options:

ONE_TIME,

MULTIPLE_PAYMENTS

Example:

"ONE_TIME"

data.nextBilling

string | null

Data e hora da próxima cobrança, ou null para cobranças únicas.

Example:

null

data.customer

object

Os dados do seu cliente.

error

any

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>"
}

API Reference

Authorizations

Response