Listar cobranças

curl --request GET \
  --url https://api.aobapay.com/v1/charges \
  --header 'Authorization: Bearer <token>'

{
  "error": "<unknown>",
  "status": 200,
  "data": {
    "data": [
      {
        "id": "ch_123456",
        "externalID": "pedido-123",
        "brCode": "00020101021226950014br.gov.bcb.pix",
        "brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8b",
        "amount": 200,
        "comment": "Pagamento para pedido #123",
        "expiration": 300,
        "fee": 78,
        "expiresAt": "2025-09-25 13:07:27",
        "status": "PENDING",
        "customer": {
          "id": "cus_2243f989-f044-49cc-84db-3ff9e4908dde",
          "name": "João da Silva",
          "document": "12345678900",
          "email": "[email protected]",
          "phone": "+5511987654321"
        },
        "createdAt": "2025-09-25 13:07:27",
        "updatedAt": "2025-09-25 13:07:27"
      }
    ],
    "meta": {
      "current_page": 1,
      "last_page": 1,
      "per_page": 10,
      "total": 1
    }
  }
}

GET

charges

Listar cobranças

curl --request GET \
  --url https://api.aobapay.com/v1/charges \
  --header 'Authorization: Bearer <token>'

{
  "error": "<unknown>",
  "status": 200,
  "data": {
    "data": [
      {
        "id": "ch_123456",
        "externalID": "pedido-123",
        "brCode": "00020101021226950014br.gov.bcb.pix",
        "brCodeImageUrl": "https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8b",
        "amount": 200,
        "comment": "Pagamento para pedido #123",
        "expiration": 300,
        "fee": 78,
        "expiresAt": "2025-09-25 13:07:27",
        "status": "PENDING",
        "customer": {
          "id": "cus_2243f989-f044-49cc-84db-3ff9e4908dde",
          "name": "João da Silva",
          "document": "12345678900",
          "email": "[email protected]",
          "phone": "+5511987654321"
        },
        "createdAt": "2025-09-25 13:07:27",
        "updatedAt": "2025-09-25 13:07:27"
      }
    ],
    "meta": {
      "current_page": 1,
      "last_page": 1,
      "per_page": 10,
      "total": 1
    }
  }
}

Authorizations

Authorization

string

header

required

Cabeçalho de autenticação Bearer no formato Bearer <aobapay-api-key> onde <aobapay-api-key> é a sua chave de API.

Query Parameters

startDate

string<date>

Data de início no formato YYYY-MM-DD

Example:

"2025-01-01"

endDate

string<date>

Data de término no formato YYYY-MM-DD

Example:

"2025-12-31"

sort

string

Ordenar por campo (id, createdAt)

Example:

"createdAt"

order

string

Ordenar em ordem (asc, desc)

Example:

"desc"

Response

Lista de cobranças retornada com sucesso

error

null

status

integer

Example:

200

data

object

Show child attributes

data.data

object[]

Show child attributes

data.data.id

string

Identificador único do QRCode Pix.

Example:

"ch_123456"

data.data.externalID

string

Identificador único do QRCode Pix no seu sistema.

Example:

"pedido-123"

data.data.brCode

string

Código copia-e-cola do QRCode Pix.

Example:

"00020101021226950014br.gov.bcb.pix"

data.data.brCodeImageUrl

string

Imagem em Base64 do QRCode Pix.

Example:

"https://api.aobapay.com/v1/qrcode/ch_abb6bc4f-f55d-45ff-8b"

data.data.amount

number

Valor a ser pago.

Example:

200

data.data.comment

string

Comentário opcional sobre o QRCode Pix.

Example:

"Pagamento para pedido #123"

data.data.expiration

integer

Data de expiração do QRCode Pix em segundos.

Example:

300

data.data.fee

number

Taxas da plataforma

Example:

78

data.data.expiresAt

string

Data de expiração do QRCode Pix.

Example:

"2025-09-25 13:07:27"

data.data.status

enum<string>

Informação sobre o andamento do QRCode Pix.

Available options:

PENDING,

EXPIRED,

FAILED,

PAID,

REFUNDED

Example:

"PENDING"

data.data.customer

object

Dados do cliente associado ao QRCode Pix.

Show child attributes

data.data.customer.id

string

Identificador único do cliente.

Example:

"cus_2243f989-f044-49cc-84db-3ff9e4908dde"

data.data.customer.name

string

Nome do cliente.

Example:

"João da Silva"

data.data.customer.document

string

Documento do cliente (CPF ou CNPJ).

Example:

"12345678900"

data.data.customer.email

string

Endereço de e-mail do cliente.

Example:

"[email protected]"

data.data.customer.phone

string

Número de telefone do cliente.

Example:

"+5511987654321"

data.data.createdAt

string

Data de criação do QRCode Pix.

Example:

"2025-09-25 13:07:27"

data.data.updatedAt

string

Data de atualização do QRCode Pix.

Example:

"2025-09-25 13:07:27"

data.meta

object

Show child attributes

data.meta.current_page

integer

Example:

1

data.meta.last_page

integer

Example:

1

data.meta.per_page

integer

Example:

10

data.meta.total

integer

Example:

1

Extornar cobrança Obter detalhes da conta

⌘I

API Reference

Authorizations

Query Parameters

Response