API Reference
Customers
Orders
Create an order
POST
/
orders
curl --request POST \
--url https://api.kohortpay.com/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customerEmail": "[email protected]",
"customerPhoneNumber": "+1 555 555 5555",
"customerFirstName": "John",
"customerLastName": "Doe",
"customerId": "cus_xxxxxxxxxxxxxxxx",
"metadata": {
"basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
},
"amount": 35000,
"locale": "en_US",
"clientReferenceId": "myclientid-1234",
"paymentGroupShareId": "KHTPAY-XXXXXXXX"
}'
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
201 - application/json
Order successfully created.
The response is of type object
.
curl --request POST \
--url https://api.kohortpay.com/orders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"customerEmail": "[email protected]",
"customerPhoneNumber": "+1 555 555 5555",
"customerFirstName": "John",
"customerLastName": "Doe",
"customerId": "cus_xxxxxxxxxxxxxxxx",
"metadata": {
"basket_id": "1JYLo8KerLxWZaQtys6ZQ1xS"
},
"amount": 35000,
"locale": "en_US",
"clientReferenceId": "myclientid-1234",
"paymentGroupShareId": "KHTPAY-XXXXXXXX"
}'
{
"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"
}