Listar links de pagamento

Listar links de pagamento

get

Retorna uma lista paginada de links de pagamento com filtros opcionais

Autorizações

ApiKeyAuth

Parâmetros de consulta

typestring · enumObrigatório

Tipo do link de pagamento

Valores possíveis:

customerDocumentstringOpcional

Documento do cliente para filtro

namestringOpcional

Nome para filtro

statusstringOpcional

Status do link para filtro

emailstring · emailOpcional

Email para filtro

documentstringOpcional

Documento para filtro

notificationEmailstring · emailOpcional

Email de notificação para filtro

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

pageinteger · int32Opcional

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

Default: 0

sizeinteger · int32 · mín: 1Opcional

Quantidade de itens por página

Default: 20

sortstring[]Opcional

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

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 links de pagamento retornada com sucesso

application/json

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

get

HTTPcURLJavaScriptPython

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

{
  "content": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-09-26T17:06:27.666Z",
      "title": "text",
      "value": 1,
      "url": "https://example.com",
      "processed": 1
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "size": 1,
  "number": 1,
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "empty": true
}