Cria um link de pagamento

POST/v1/checkouts/payment-links

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

Corpo da requisição

namestringobrigatório
Nome do link, para a sua referência.
itemsobject[]obrigatório
O carrinho fixo do link (1 a 100 linhas).
+2 campos de items
- idstringobrigatório
  Uma variante do seu catálogo.
- quantityinteger
  Quantidade.
domainIdstring
O host em que a URL é montada: um dos seus domínios de checkout prontos, ou dmn_shared (o host da plataforma). Omitido = o seu domínio pronto mais antigo, senão o host da plataforma.
editableboolean
Se o comprador pode mudar as quantidades.
metadataobject
Objeto 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)
Quando o link deixa de abrir.
templateIdstring
Um template de checkout seu (aparência); omitido = o checkout padrão.
availableAtstring (date-time)
Quando o link passa a abrir.
customInputsobject[]
Campos extras que o checkout pede ao comprador (JSON livre, até 50).
integrationIdstring
A integração a que uma venda por este link pertence (app_…): a sessão de checkout é marcada com ela.

Respostas

201Criado

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

400Requisição inválida (validação)

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

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

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

AnteriorLista os links de pagamento PróximaConsulta uma sessão de checkout

curl -X POST "https://api.selectwin.io/v1/checkouts/payment-links" \ -H "SelectKey: $SELECTWIN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Ltda", "items": [ { "id": "var_0a1b2c3d4e5f60718293", "quantity": 1 } ], "domainId": "dmn_0a1b2c3d4e5f60718293", "editable": false, "metadata": {}, "discounts": [ "string" ], "expiresAt": "2026-01-15T12:00:00.000Z", "templateId": "tmpl_0a1b2c3d4e5f60718293", "availableAt": "2026-01-15T12:00:00.000Z", "customInputs": [ {} ], "integrationId": "app_0a1b2c3d4e5f60718293" }'

{ "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" }