GET
/
orders
/
{id}
curl --request GET \
  --url https://api.kohortpay.com/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "ord_1234567890",
  "livemode": true,
  "organizationId": "org_1234567890",
  "amount": 35000,
  "amountCashback": 5000,
  "applicationFeeAmount": 1000,
  "customerEmail": "[email protected]",
  "customerFirstName": "John",
  "customerLastName": "Doe",
  "customerPhoneNumber": "+1 555 555 5555",
  "paymentGroupShareId": "KHT-XXXXXXXX",
  "customerId": "cus_xxxxxxxxxxxxxxxx",
  "currency": "EUR",
  "locale": "en_US",
  "status": "CASHBACK_SENT",
  "metadata": {
    "basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
  },
  "paymentGroupId": "pg_1234567890",
  "ambassadorId": "amb_1234567890",
  "clientReferenceId": "1234567890",
  "riskLevel": "LOW",
  "createdAt": "2021-07-22T00:00:00.000Z",
  "createdBy": "usr_1234567890",
  "updatedAt": "2021-07-22T00:00:00.000Z",
  "updatedBy": "usr_1234567890"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique order ID

Query Parameters

​
expand
string[]

Fields to expand related entities. For example, ["organization"].

​
take
number

Maximum number of items to retrieve. Default is 25.

Example:

10

​
skip
number

Number of items to skip before starting to collect the result set.

Example:

0

​
orderBy
string

Field to order the results by, followed by ":asc" or ":desc". For example, "createdAt:desc".

Example:

"createdAt:desc"

​
search
string

Search term to filter the results. Supports multiple terms with "~" for partial matches.

Example:

"[email protected]"

​
any

Response

200 - application/json

Order successfully retrieved.

The response is of type object.