Listar Links de Pagamento

Listar links de pagamento

get

Retorna uma lista paginada de links de pagamento com filtros opcionais

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Query parameters

typestring · enumRequired

Tipo do link de pagamento

Possible values:

customerDocumentstringOptional

Documento do cliente para filtro

namestringOptional

Nome para filtro

statusstringOptional

Status do link para filtro

emailstring · emailOptional

Email para filtro

documentstringOptional

Documento para filtro

notificationEmailstring · emailOptional

Email de notificação para filtro

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

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

sortstring[]Optional

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

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

application/json

totalElementsinteger · int64Optional

totalPagesinteger · int32Optional

sizeinteger · int32Optional

numberinteger · int32Optional

numberOfElementsinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

emptybooleanOptional

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

/v2/payment-links

HTTPcURLJavaScriptPython

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

{
  "content": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2026-02-20T18:28:14.472Z",
      "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
}