Listar cobranças

Listar cobranças

get

Retorna uma lista paginada de cobranças com filtros

Autorizações

ApiKeyAuth

Parâmetros de consulta

customerDocumentstringOpcional

Documento do cliente para filtro

namestringOpcional

Nome para filtro

emailstring · emailOpcional

Email para filtro

documentstringOpcional

Documento para filtro

notificationEmailstring · emailOpcional

Email de notificação para filtro

statusstring · enumOpcional

Status da cobrança para filtro

Valores possíveis:

paymentMethodstringOpcional

Método de pagamento para filtro

expirationDateInitialstring · dateOpcional

Data inicial de expiração para filtro

expirationDateFinalstring · dateOpcional

Data final de expiração para filtro

startCreatedAtstring · date-timeOpcional

Data inicial de criação para filtro

endCreatedAtstring · date-timeOpcional

Data final de criação para filtro

sortstringOpcional

Campo para ordenação

pagestringOpcional

Número da página

sizestringOpcional

Tamanho da página

idempotencyKeystringOpcional

Chave de idempotência como query parameter

Parâmetros de cabeçalho

X-Token-ApistringObrigatório

Token de autenticação para acesso à API

Content-Typestring · enumOpcional

Tipo de conteúdo da requisição

Valores possíveis:

x-ip-origin-requeststringOpcional

IP de origem da requisição

x-idempotency-keystringOpcional

Chave de idempotência

Respostas

200

Lista de cobranças retornada com sucesso

application/json

201

Cobrança criada com sucesso

application/json

202

Requisição aceita para processamento

204

Sem conteúdo

301

Redirecionamento permanente

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

503

Serviço indisponível

application/json

get

HTTPcURLJavaScriptPython

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

{
  "content": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "status": "PENDING",
      "value": 100.5,
      "title": "Cobrança de produto",
      "description": "Descrição da cobrança",
      "uuidBuyer": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2024-12-31",
      "notificationEmail": "[e-mail]",
      "createdAt": "2024-03-20T10:00:00Z",
      "updatedAt": "2024-03-20T10:00:00Z",
      "paymentMethod": "CREDIT_CARD",
      "metadata": [
        {
          "key": "código",
          "value": "YMC"
        }
      ]
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1
}