GET /api/v2/orders/{id}

GET

/api/v2/orders/{id}

Get order

Header parameters

Attribute	Type	Requirement	Description
`x-public-key`	string	MANDATORY	Public key that identifies the merchant account.

Request parameters

—

Response parameters

Attribute	Type	Requirement	Description
`data`	object	OPTIONAL
`url`	string	OPTIONAL	Checkout redirect URL.
`params`	object	OPTIONAL
`id`	string	OPTIONAL
`googleAnalyticsClientId`	string	OPTIONAL
`metaData`	object	OPTIONAL
`meta`	array	OPTIONAL	Metadata array (can be empty).

Errors and interpretation

See general reference: Endpoint response errors

Request

curl -X GET \\
  'https://api.example.com/api/v2/orders/{id}' \\
  -H 'Content-Type: application/json' \\
  -H 'Authorization: Bearer YOUR_TOKEN'

<?php
$ch = curl_init('https://api.example.com/api/v2/orders/{id}');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_TOKEN',
  ],
]);

$res = curl_exec($ch);
$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

echo "HTTP {$code}
" . $res;

Response

200

{
    "data": {
        "url": "https://checkout.example.com/redirect/abc",
        "params": {
            "id": "ord_123",
            "googleAnalyticsClientId": "GA1.2.123456789.1234567890",
            "metaData": {
                "utm_source": "google"
            }
        }
    },
    "meta": []
}