v1

latestOpenAPI 3.0.02026-07-2420104111.7 KB

Gerenciamento de Pedidos

Consultar resposta de checkout

Consulta a resposta de checkout de um pedido específico. Retorna informações sobre o status do checkout, respostas de pagamento e detalhes do processamento. Útil para verificar o status de pedidos processados de forma assíncrona.

get/partners/api/v5/orders/{id}/checkout-response

Path parameters

idstring required

Example:Q4RPRZ85

Identificador único do pedido

Response

Resposta de checkout do pedido solicitado

successboolean required

Indica se a operação foi bem-sucedida

messagestring required

Mensagem de resposta

timestampstring required

Timestamp da resposta

Example response

{
  "success": true,
  "data": {
    "orderId": "Q4RPRZ85",
    "checkoutId": "checkout_789012",
    "status": "completed",
    "createdAt": "2024-04-29T17:09:32Z",
    "updatedAt": "2024-04-29T17:09:32Z",
    "externalOrderId": "PARTNER12345",
    "totalAmount": 57.23,
    "currency": "BRL",
    "paymentResponses": [
      {
        "id": "payment_resp_123456",
        "status": "approved",
        "amount": 57.23,
        "currency": "BRL",
        "gateway": "mercadoPago",
        "externalId": "123456789",
        "processedAt": "2024-04-29T17:09:32Z",
        "responseCode": "00",
        "responseMessage": "Transação aprovada"
      }
    ],
    "checkoutStatus": {
      "status": "completed",
      "message": "Checkout processado com sucesso",
      "timestamp": "2024-04-29T17:09:32Z",
      "code": "CHECKOUT_SUCCESS"
    },
    "redirectUrl": "https://www.clickbus.com.br/checkout/success",
    "errorDetails": {
      "code": "PAYMENT_FAILED",
      "message": "Pagamento rejeitado pelo gateway",
      "details": "Cartão expirado"
    },
    "metadata": {
      "sessionId": "session_123456",
      "userAgent": "Mozilla/5.0...",
      "ipAddress": "192.168.1.1"
    }
  },
  "message": "Checkout response retrieved successfully",
  "timestamp": "2024-04-29T17:09:32Z"
}