Consulta um link de pagamento

GET/v1/checkouts/payment-links/{paymentLinkId}

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

Parâmetros do caminho

paymentLinkIdstringobrigatório
Identificador público (link_…)

Respostas

200Sucesso

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á.

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

404Não encontrado

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

AnteriorLê o rastro bruto de interação de uma sessão (evento a evento)PróximaAtualiza um link de pagamento