Lista os links de pagamento

GET/v1/checkouts/payment-links

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Expressão de ordenação, ex.: "-createdAt"
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
statusstring
Só links ligados (enabled) ou desligados (disabled).
Valores:enableddisabled
templateIdum de
Só links neste template de checkout, ou default para os sem template.
domainIdstring
Identificador público (dmn_/host_/cdm_…)
qstring
Links cujo nome contém este texto (sem diferenciar maiúsculas).

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+20 campos de data
- idstringobrigatório
  Identificador público (link_…)
- namestringobrigatório
  Nome do link.
- typestringobrigatóriopode ser nulo
  Tipo do link (histórico; sempre o tipo persistido).
- itemsobject[]obrigatório
  O carrinho fixo do link.
- enabledbooleanobrigatório
  Se o link abre.
- accessIdstringobrigatório
  O id público de acesso na URL.
- domainIdstringobrigatóriopode ser nulo
  O host em que a URL é montada; null = a escolha automática.
- editablebooleanobrigatório
  Se o comprador pode mudar as quantidades.
- metadataobjectobrigatóriopode ser nulo
  Os seus metadados chave-valor; null quando não há.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- discountsany[]obrigatóriopode ser nulo
  Códigos de cupom aplicados quando o link abre; null quando não há.
- expiresAtstringobrigatóriopode ser nulo
  Quando o link deixa de abrir; null = nunca.
- sessionIdstringobrigatóriopode ser nulo
  A sessão de checkout ligada ao link, quando há.
- signaturestringobrigatório
  A assinatura da URL.
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- templateIdstringobrigatóriopode ser nulo
  O template de checkout; null = o checkout padrão.
- availableAtstringobrigatóriopode ser nulo
  Quando o link passa a abrir; null = já abre.
- customInputsobject[]obrigatóriopode ser nulo
  Campos extras que o checkout pede ao comprador; null quando não há.
- accessFullUrlstringobrigatóriopode ser nulo
  A URL para compartilhar com os compradores.
- integrationIdstringobrigatóriopode ser nulo
  A integração a que uma venda pelo link pertence; null quando não há.
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorCria uma sessão de checkout PróximaCria um link de pagamento

{ "data": [ { "id": "link_0a1b2c3d4e5f60718293", "name": "Acme Ltda", "type": "string", "items": [ {} ], "enabled": true, "accessId": "string", "domainId": "string", "editable": true, "metadata": {}, "createdAt": "string", "discounts": [], "expiresAt": "string", "sessionId": "string", "signature": "string", "updatedAt": "string", "templateId": "string", "availableAt": "string", "customInputs": [ {} ], "accessFullUrl": "string", "integrationId": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "offset": 0, "hasMore": true }