Iniciar processo de pagamento de pedido
Em desenvolvimento
POST
/orders/pay/
Rota: /orders/pay/
Descrição: Esta rota é utilizada para iniciar o processo de pagamento de um pedido ou carrinho de compras existente. A requisição deve conter o identificador do pedido (orderId) e os detalhes do método de pagamento escolhido pelo usuário (preferencialmente com dados de cartão tokenizados por um SDK do gateway de pagamento, jamais dados brutos). O sistema, então, interage com o gateway de pagamento para processar a transação. A resposta inicial informará o status da tentativa de pagamento e, se necessário, fornecerá uma URL para redirecionamento do usuário (ex: para autenticação 3D Secure, página de PIX ou boleto).
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/orders/pay/' \
--header 'Content-Type: application/json' \
--data-raw '{
"orderId": "ORDER-987698", // ID do pedido ou carrinho que será pago
"paymentMethod": {
"type": "credit_card",
"cardToken": "tok_xxxx_xxxxxxxxxxxx", // **Token do cartão** gerado pelo SDK do Gateway (NUNCA o número do cartão direto!)
"installments": 1, // Número de parcelas (para cartão de crédito)
"cardHolderName": "Nome Completo Titular" // Nome do titular do cartão (pode ser opcional dependendo do gateway)
},
"returnUrl": "https://sua-app.com/payment-callback", // URL para onde o usuário será redirecionado após a interação com o gateway (ex: 3DS, página de PIX)
"notificationUrl": "https://sua-api.com/webhooks/payment-status" // URL para webhooks de atualização de status do gateway (opcional, mas recomendado)
}'Response Response Example
202 - Example 1
{
"message": {
"title": "Pagamento Iniciado",
"text": "Sua solicitação de pagamento foi recebida e está sendo processada.",
"description": "O status inicial da transação é 'pending' ou 'processing'. Você pode precisar ser redirecionado para um ambiente externo para concluir o pagamento ou aguardar a confirmação final."
},
"success": true,
"status": 202,
"data": {
"paymentId": "PAY-287654", // ID transação de pagamento
"orderId": "ORDER-908765",
"status": "pending",
"amountPaid": 150.00,
"paymentMethodType": "credit_card",
"transactionDetails": { //informações sobre o gateway
"gatewayTransactionId": "GTW-67890",
"gatewayStatus": "AUTHORIZED"
},
"redirectUrl": "https://gateway.com/auth/3ds/redirect/12345"
}
}Requisição
Parâmetros Bodyapplication/json
Respostas
Modificado em 2025-06-12 12:36:06