Atualiza um link de pagamento
/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órioIdentificador público (link_…)
Corpo da requisição
namestringNome do link, para a sua referência.
itemsobject[]O carrinho fixo do link (1 a 100 linhas).
+2 campos de
itemsidstringobrigatórioUma variante do seu catálogo.
quantityintegerQuantidade.
enabledbooleanLiga ou desliga o link sem trocar a URL.
domainIdstringpode ser nuloMover o link para outro host (reescreve
accessFullUrl, nãoaccessId);null= volta à escolha automática.editablebooleanSe o comprador pode mudar as quantidades.
metadataobjectObjeto JSON livre — no máximo 50 chaves, chaves de até 40 caracteres, cada valor com até 500 caracteres (o JSON dele, quando não é texto), o objeto inteiro com até 8192 bytes em JSON.
discountsstring[]Códigos de cupom aplicados quando o link abre (validados na cobrança).
expiresAtstring (date-time)pode ser nuloQuando o link deixa de abrir;
nulllimpa.templateIdstringpode ser nuloUm template de checkout seu;
null= volta ao checkout padrão.availableAtstring (date-time)pode ser nuloQuando o link passa a abrir;
nulllimpa.customInputsobject[]Campos extras que o checkout pede ao comprador (JSON livre, até 50).
integrationIdstringA integração a que uma venda por este link pertence (
app_…): a sessão de checkout é marcada com ela.
Respostas
200Sucesso
idstringobrigatórioIdentificador público (link_…)
namestringobrigatórioNome do link.
typestringobrigatóriopode ser nuloTipo do link (histórico; sempre o tipo persistido).
itemsobject[]obrigatórioO carrinho fixo do link.
enabledbooleanobrigatórioSe o link abre.
accessIdstringobrigatórioO id público de acesso na URL.
domainIdstringobrigatóriopode ser nuloO host em que a URL é montada;
null= a escolha automática.editablebooleanobrigatórioSe o comprador pode mudar as quantidades.
metadataobjectobrigatóriopode ser nuloOs seus metadados chave-valor;
nullquando não há.createdAtstringobrigatórioQuando o recurso foi criado (ISO 8601, UTC).
discountsany[]obrigatóriopode ser nuloCódigos de cupom aplicados quando o link abre;
nullquando não há.expiresAtstringobrigatóriopode ser nuloQuando o link deixa de abrir;
null= nunca.sessionIdstringobrigatóriopode ser nuloA sessão de checkout ligada ao link, quando há.
signaturestringobrigatórioA assinatura da URL.
updatedAtstringobrigatórioQuando o recurso foi atualizado pela última vez (ISO 8601, UTC).
templateIdstringobrigatóriopode ser nuloO template de checkout;
null= o checkout padrão.availableAtstringobrigatóriopode ser nuloQuando o link passa a abrir;
null= já abre.customInputsobject[]obrigatóriopode ser nuloCampos extras que o checkout pede ao comprador;
nullquando não há.accessFullUrlstringobrigatóriopode ser nuloA URL para compartilhar com os compradores.
integrationIdstringobrigatóriopode ser nuloA integração a que uma venda pelo link pertence;
nullquando não há.
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
404Não encontrado
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
422Regra de negócio impede o processamento
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório