Listar Cobranças

Listar cobranças

get

https://api.barte.comhttps://sandbox-api.barte.com

/v2/charges

Retorna uma lista paginada de cobranças com filtros

Authorizations

ApiKeyAuth

Query parameters

customerDocumentstringOptional

Documento do cliente para filtro

namestringOptional

Nome para filtro

emailstring · emailOptional

Email para filtro

documentstringOptional

Documento para filtro

notificationEmailstring · emailOptional

Email de notificação para filtro

statusstring · enumOptional

Status da cobrança para filtro

Possible values:

paymentMethodstringOptional

Método de pagamento para filtro

expirationDateInitialstring · dateOptional

Data inicial de expiração para filtro

expirationDateFinalstring · dateOptional

Data final de expiração para filtro

startCreatedAtstring · date-timeOptional

Data inicial de criação para filtro

endCreatedAtstring · date-timeOptional

Data final de criação para filtro

sortstring[]Optional

Critérios de ordenação (sort=name,asc&sort=createdAt,desc)

pageinteger · int32Optional

Número da página (começando em 0)

Default: 0

sizeinteger · int32 · min: 1Optional

Quantidade de itens por página

Default: 20

idempotencyKeystringOptional

Chave de idempotência como query parameter

Header parameters

X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:

x-ip-origin-requeststringOptional

IP de origem da requisição

x-idempotency-keystringOptional

Chave de idempotência

Responses

200

Lista de cobranças retornada com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Recurso não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

get

/v2/charges

HTTPcURLJavaScriptPython

GET /v2/charges HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Accept: */*

{
  "content": [
    {
      "uuid": "f337e5a4-62a3-41af-8449-c9898f1de66b",
      "title": "Teste",
      "expirationDate": "2025-10-14",
      "value": 100,
      "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
      "status": "PAID",
      "customer": {
        "document": "001052647",
        "type": "SSN",
        "name": "Joshua Henry",
        "email": "[email protected]",
        "phone": "9409822523"
      },
      "authorizationCode": "7021748",
      "authorizationNsu": "5737396",
      "refunds": [
        {}
      ],
      "createdAt": "2025-10-14 22:35:30",
      "paidDate": "2025-10-14",
      "originalValue": 100,
      "installments": 5,
      "brand": "mastercard",
      "errorReason": null
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}