Cria (ou renova) o link de teste em sandbox de um link de pagamento de produção

POST/v1/checkouts/payment-links/{paymentLinkId}/test

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

linkobjectobrigatório
O link de teste no sandbox.
+20 campos de link
- 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á.
itemsobject[]obrigatório
As linhas do link de teste.
+5 campos de items
- quantityintegerobrigatório
  Quantidade.
- copiedNowbooleanobrigatório
  Se a cópia no sandbox foi criada por este teste.
- productIdstringobrigatório
  O produto no sandbox da cópia.
- variantIdstringobrigatório
  A cópia dela no sandbox.
- liveVariantIdstringobrigatório
  A variante de produção.
createdbooleanobrigatório
true no primeiro teste deste link; false quando o link de teste já existia e foi refeito (mesma URL).
resourcestringobrigatório
Sempre checkout-paymentLinkTest.
Valores:checkout-paymentLinkTest
warningsobject[]obrigatório
O que não passou da produção para o link de teste.
+2 campos de warnings
- codestringobrigatório
  O que não passou: variantsNotOnSale, couponsNotInSandbox, templateNotCarried ou integrationNotCarried.
  Valores:variantsNotOnSalecouponsNotInSandboxtemplateNotCarriedintegrationNotCarried
- valuesstring[]
  Os ids ou códigos afetados.
liveLinkIdstringobrigatório
O link de produção que este link de teste espelha.

201Criado

linkobjectobrigatório
O link de teste no sandbox.
+20 campos de link
- 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á.
itemsobject[]obrigatório
As linhas do link de teste.
+5 campos de items
- quantityintegerobrigatório
  Quantidade.
- copiedNowbooleanobrigatório
  Se a cópia no sandbox foi criada por este teste.
- productIdstringobrigatório
  O produto no sandbox da cópia.
- variantIdstringobrigatório
  A cópia dela no sandbox.
- liveVariantIdstringobrigatório
  A variante de produção.
createdbooleanobrigatório
true no primeiro teste deste link; false quando o link de teste já existia e foi refeito (mesma URL).
resourcestringobrigatório
Sempre checkout-paymentLinkTest.
Valores:checkout-paymentLinkTest
warningsobject[]obrigatório
O que não passou da produção para o link de teste.
+2 campos de warnings
- codestringobrigatório
  O que não passou: variantsNotOnSale, couponsNotInSandbox, templateNotCarried ou integrationNotCarried.
  Valores:variantsNotOnSalecouponsNotInSandboxtemplateNotCarriedintegrationNotCarried
- valuesstring[]
  Os ids ou códigos afetados.
liveLinkIdstringobrigatório
O link de produção que este link de teste espelha.

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

409Conflito (idempotência ou estado)

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

422Regra de negócio impede o processamento

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 resumo comportamental + o diagnóstico de intenção/abandono de uma sessão PróximaEmite a credencial de telemetria da sessão para o front-end do checkout