Skip to content

🔗 Link de Pagamento

📋 Visão Geral

O Link de Pagamento permite que um pedido seja criado antecipadamente (sem cobrança) e enviado ao cliente final para conclusão do pagamento de forma independente, através de um formulário/iframe público.

O código é gerado a partir do carrinho administrativo (POST /carts/{cartId}/generate-payment-code). A partir daí, este módulo expõe a operação de atualização das formas de pagamento permitidas no link já gerado.

🔄 Entidades Envolvidas

Cada link de pagamento (OrderGroupPaymentCode) está associado a um único grupo de pedido e guarda a allowlist de opções de pagamento e a data de expiração.

📌 Notas e Considerações

  • O link só pode ser utilizado enquanto o pedido estiver com status aguardando pagamento e dentro do prazo de expiração configurado na geração.
  • A consulta pública do pedido pelo código e a finalização do pagamento estão documentadas na API Pública, seção Link de Pagamento.
  • Operações de atualização exigem os escopos ORDER_READ e ORDER_WRITE.

Atualizar Link de Pagamento

PUT /orders/groups/payment-code/{code}

Atualiza as formas de pagamento permitidas de um link de pagamento já gerado.

Permite alterar a allowlist de formas de pagamento de um link de pagamento já gerado, sem precisar gerar um novo código (o link enviado ao cliente permanece o mesmo).

Substitui integralmente a lista de opções de pagamento anteriormente configurada — envie sempre a lista completa das opções que devem permanecer válidas.

Assim como na geração, a atualização só é permitida enquanto o pedido estiver com status aguardando pagamento e o link ainda não tiver expirado.

HeaderValorDescrição
AuthorizationBearer {token}Token do usuário autenticado na API privada com escopos ORDER_READ e ORDER_WRITE.
Content-Typeapplication/jsonTipo de conteúdo da requisição.

ParâmetroTipoObrigatórioDescrição
codestringSimCódigo público do link de pagamento.

ParâmetroTipoObrigatórioDescrição
paymentOptionsarraySimLista completa de opções de pagamento permitidas no link. Mínimo de 1 item.
paymentOptions.*.paymentOptionIdintegerSimID da opção de pagamento permitida.
paymentOptions.*.settingsobjectNãoConfigurações adicionais específicas da opção de pagamento nesse link.

1curl --request PUT \
2  --url '{{MAIN_URL}}/orders/groups/payment-code/a1b2c3d4e5f6' \
3  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
4  --header 'Content-Type: application/json' \
5  --data '{
6    "paymentOptions": [
7      { "paymentOptionId": 1 }
8    ]
9  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "status": true,
3  "data": {
4    "orderGroupId": 345,
5    "code": "a1b2c3d4e5f6",
6    "paymentOptions": [
7      { "paymentOptionId": 1, "settings": [] }
8    ],
9    "expiresAt": "2026-08-29 14:30:06",
10    "createdAt": "2026-08-27 14:30:06",
11    "updatedAt": "2026-08-27 15:02:11"
12  }
13}

CampoTipoDescrição
orderGroupIdintegerID do grupo de pedido vinculado ao link.
codestringCódigo público do link de pagamento.
paymentOptionsarrayFormas de pagamento permitidas, já atualizadas.
expiresAtdateData/hora de expiração do link (não é alterada por esta operação).
createdAtdateData de criação do registro.
updatedAtdateData da última atualização do registro.

⚠️ Possíveis erros:

Código InternoCódigo HttpDescrição
UAPPI_STORE_ORDER_PAYMENT_CODE_NOT_FOUND404O código de link de pagamento informado não foi encontrado.
UAPPI_STORE_ORDER_PAYMENT_CODE_EXPIRED400O link de pagamento já expirou.
UAPPI_STORE_ORDER_PAYMENT_CODE_INVALID_ORDER_STATUS409O pedido vinculado ao link não está mais aguardando pagamento (já foi pago, cancelado, etc).
UAPPI_STORE_ORDER_INVALID_PAYMENT_OPTION400Uma das opções de pagamento informadas não é válida para a política comercial do pedido.

Uappi é a melhor opção para o crescimento da sua loja!

Institucional

;