v3

latestOpenAPI 3.1.02026-08-044524163.2 KB

Listar Checkouts

Retorna todos os Checkouts que você criou.

Você pode usar essa rota para listar todos seus Checkouts e visualizar seus status, valores e informações relacionadas.

get/checkouts/list

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger

Example:100

Quantidade de itens por página (1-100).

startDatestring date

Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date

Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring

Example:bill_abc123xyz

Filtrar por identificador único do Checkout

externalIdstring

Example:pedido-123

Filtrar por identificador do Checkout no seu sistema

status'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'REFUNDED'

Filtrar por status do Checkout

emailstring

Example:daniel_lima@abacatepay.com

Filtrar por e-mail do cliente associado

taxIdstring

Example:123.456.789-01

Filtrar por CPF ou CNPJ do cliente associado

Response

Checkouts listados com sucesso.

successboolean

Se a requisição obteve sucesso ou não.

errorstring nullable

Example response

{
  "data": [
    {
      "id": "bill_abc123xyz",
      "externalId": "pedido-123",
      "url": "https://app.abacatepay.com/pay/bill_abc123xyz",
      "amount": 10000,
      "items": [
        {
          "id": "prod_456",
          "quantity": 2
        }
      ],
      "status": "PENDING",
      "coupons": [],
      "upSellProductId": "prod_bump456xyz",
      "installmentsCount": 3,
      "dueDate": "2026-08-15",
      "interest": {
        "value": 100
      },
      "fine": {
        "value": 200,
        "type": "PERCENTAGE"
      },
      "metadata": {},
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}