Skip to main content
GET
/
charges
Get all charges
curl --request GET \
  --url http://api.contabull.com/charges
{
  "charges": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "customerId": "<string>",
      "customer": {
        "name": "<string>"
      },
      "amountCents": 123,
      "taxFine": 123,
      "taxInterest": 123,
      "currency": "<string>",
      "paymentMethods": [
        "pix"
      ],
      "status": "CREATING",
      "dueAt": "2023-11-07T05:31:56Z",
      "expiredAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "totalPages": 123,
  "currentPage": 123,
  "hasMore": true
}

Query Parameters

accountId
string
status
enum<string>
Available options:
ALL,
CREATING,
CREATED,
PAID,
CANCELLED,
FAILED
query
string
from
string<date-time>
to
string<date-time>
page
number
default:1

Response

default - application/json
charges
object[]
required
total
number
required
totalPages
number
required
currentPage
number
required
hasMore
boolean
required