List orders

GET

orders

curl --request GET \
  --url https://api.kohortpay.com/orders \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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"
    }
  ],
  "count": 123
}

Authorizations

Authorization

string

header

required

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

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"

string

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

Example:

"[email protected]"

Response

200 - application/json

Orders successfully retrieved.

data

object[]

required

data.id

string

required

The id of the order.

Example:

"ord_1234567890"

data.livemode

boolean

required

Wether the order is in live mode or test mode.

Example:

true

data.organizationId

string

required

The id of the organization.

Example:

"org_1234567890"

data.amount

number

required

The total amount of the order in cents.

Required range: x >= 0

Example:

35000

data.amountCashback

number | null

required

The cashback amount of the order in cents.

Required range: x >= 0

Example:

5000

data.applicationFeeAmount

number | null

required

The fees due to Kohort for this order in cents.

Required range: x >= 0

Example:

1000

data.customerEmail

string

required

The email of the customer.

Example:

"[email protected]"

data.customerFirstName

string

required

The first name of the customer.

Example:

"John"

data.customerLastName

string

required

The last name of the customer.

Example:

"Doe"

data.customerPhoneNumber

string

required

The phone number of the customer.

Example:

"+1 555 555 5555"

The shared identifier of the group. If null, it will create a group. If not null, it will join the group.

Example:

"KHT-XXXXXXXX"

data.customerId

string

required

The ID of the customer.

Example:

"cus_xxxxxxxxxxxxxxxx"

data.currency

enum<string>

default:EUR

required

The currency of the order.

Available options:

EUR

Example:

"EUR"

data.locale

enum<string>

default:fr_FR

required

The locale of the order.

Available options:

en_US,

fr_FR

Example:

"en_US"

data.status

enum<string>

required

The current status of the order.

Available options:

CREATED,

CASHBACK_AVAILABLE,

CASHBACK_PROCESSING,

CASHBACK_SENT

Example:

"CASHBACK_SENT"

data.metadata

object

required

Additional metadata for the order.

Example:

{ "basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS" }

data.paymentGroupId

string | null

required

The id of the associated group.

Example:

"pg_1234567890"

data.ambassadorId

string | null

required

The id of the associated ambassador.

Example:

"amb_1234567890"

data.clientReferenceId

string | null

required

The reference id of the client. Use this field to renconcile with your system.

Example:

"1234567890"

data.riskLevel

enum<string>

required

The risk level of the order.

Available options:

LOW,

MEDIUM,

HIGH,

HIGHEST

Example:

"LOW"

data.createdAt

string

required

Example:

"2021-07-22T00:00:00.000Z"

data.createdBy

string | null

required

The id of the user who created the customer.

Example:

"usr_1234567890"

data.updatedAt

string

required

Example:

"2021-07-22T00:00:00.000Z"

data.updatedBy

string | null

required

The id of the user who last updated the customer.

Example:

"usr_1234567890"

count

number

required

Total count of orders

Unblock customer Create an order

curl --request GET \
  --url https://api.kohortpay.com/orders \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "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"
    }
  ],
  "count": 123
}

API Reference

Customers

Orders

Referral Groups

Authorizations

Query Parameters

Response