CHcheckout
Forward

Get forward request

Retrieve the details of a successfully forwarded API request.

The details can be retrieved for up to 14 days after the request was initiated.

get/forward/{id}

Request

Path parameters

idstring required

The unique identifier of the forward request.

Response

Forward request retrieved successfully

request_idstring required

The unique identifier for the forward request.

referencestring

The unique reference for the forward request.

entity_idstring required

The client entity linked to the forward request.

created_onstring date-time required

The date and time the forward request was created, in UTC.

Example response

{
  "request_id": "fwd_01HK153X00VZ1K15Z3HYC0QGPN",
  "reference": "ORD-5023-4E89",
  "entity_id": "ent_lp6h57qskk6ubewfk3pq4f2c2y",
  "destination_request": {
    "url": "https://example.com/payments",
    "method": "POST",
    "headers": {
      "Authorization": "***redacted***",
      "Idempotency-Key": "xe4fad12367dfgrds",
      "Content-Type": "application/json"
    },
    "body": "{\"amount\": 1000, \"currency\": \"USD\", \"reference\": \"some_reference\", \"source\": {\"type\": \"card\", \"number\": \"{{card_number}}\", \"expiry_month\": \"{{card_expiry_month}}\", \"expiry_year\": \"{{card_expiry_year_yyyy}}\", \"card_pin\": \"{{card_pin}}\", \"name\": \"Ali Farid\"}, \"payment_type\": \"Regular\", \"authorization_type\": \"Final\", \"capture\": true, \"processing_channel_id\": \"pc_xxxxxxxxxxx\", \"risk\": {\"enabled\": false}, \"merchant_initiated\": true}"
  },
  "destination_response": {
    "status": 201,
    "headers": {
      "Cko-Request-Id": [
        "5fa7ee8c-f82d-4440-a6dc-e8c859b03235"
      ],
      "Content-Type": [
        "application/json"
      ]
    },
    "body": "{\"id\": \"pay_mbabizu24mvu3mela5njyhpit4\", \"action_id\": \"act_mbabizu24mvu3mela5njyhpit4\", \"amount\": 6540, \"currency\": \"USD\", \"approved\": true, \"status\": \"Authorized\", \"auth_code\": \"770687\", \"response_code\": \"10000\", \"response_summary\": \"Approved\", \"_links\": {\"self\": {\"href\": \"https://{prefix}.api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4\"}, \"action\": {\"href\": \"https://{prefix}.api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/actions\"}, \"void\": {\"href\": \"https://{prefix}.api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/voids\"}, \"capture\": {\"href\": \"https://{prefix}.api.sandbox.checkout.com/payments/pay_mbabizu24mvu3mela5njyhpit4/captures\"}}}"
  },
  "created_on": "2024-01-02T15:04:05.0000000+00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.