Reference
Orders
Manage order records including product details, pricing, discounts, taxes, and line items. Create, update, retrieve, and delete orders for payment processing and checkout sessions.
Orders are used for payment records as well as to create a checkout page.
Create
API call to create new orders(s) as single or batch records.
Path
POST /orders/create
Request Body
{
"records": [{
"reference": "ORD0045",
"description": "Monthly plan + setup",
"customer_id": "cus_abc123...",
"amount_subtotal": "1100.00",
"amount_discount": "0.00",
"amount_shipping": "0.00",
"amount_tax": "100.00",
"amount_total": "1200.00",
"currency_lookups_id": "loo_abc123...",
"order_status_lookups_id": "loo_abc123...",
"fulfillment_status_lookups_id": "loo_abc123...",
"items": [
{
"sku": "SKU00567",
"name": "Pro Plan (Monthly)",
"quantity": 1,
"unit_amount": "1200.00",
"tax_amount": 0,
"discount_amount": 0,
"currency_lookups_id": "loo_abc123...",
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}
],
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}]
}
Response Body
{
"status": true,
"results": [{
"id": "ord_abc_123...",
"reference": "ORD0045",
"description": "Monthly plan + setup",
"customer_id": "cus_abc123...",
"amount_subtotal": "1100.00",
"amount_discount": "0.00",
"amount_shipping": "0.00",
"amount_tax": "100.00",
"amount_total": "1200.00",
"currency_lookups_id": "loo_abc123...",
"order_status_lookups_id": "loo_abc123...",
"fulfillment_status_lookups_id": "loo_abc123...",
"items": [
{
"sku": "SKU00567",
"name": "Pro Plan (Monthly)",
"quantity": 1,
"unit_amount": "1200.00",
"tax_amount": 0,
"discount_amount": 0,
"currency_lookups_id": "loo_abc123...",
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}
],
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
},
"deleted_at": null,
"updated_at": null,
"created_at": "2024-02-27 09:11:23"
}]
}
Parameters
Field | Required | Type | Description | Example |
|---|---|---|---|---|
| id | n/a | String(32) | Record id returned | ord_abc123... |
| reference | Y | String(35) | Reference to identify a specific order | ORD0045 |
| description | Y | String | Description of the order | Monthly plan + setup |
| customer_id | N | String(32) | Customer ID associated with this order | cus_abc123... |
| amount_subtotal | N | String | Subtotal amount before tax, shipping, and discounts | 1100.00 |
| amount_discount | N | String | Total discount amount applied | 0.00 |
| amount_shipping | N | String | Shipping cost amount | 0.00 |
| amount_tax | N | String | Tax amount applied | 100.00 |
| amount_total | Y | String | Total order amount including all fees | 1200.00 |
| currency_lookups_id | N | String(32) | Currency lookup ID for the order | loo_abc123... |
| order_status_lookups_id | N | String(32) | Order status lookup ID | loo_abc123... |
| fulfillment_status_lookups_id | N | String(32) | Fulfillment status lookup ID | loo_abc123... |
| items.sku | Y | String | Product SKU | SKU00567 |
| items.name | Y | String | Product name | Pro Plan (Monthly) |
| items.quantity | Y | Integer | Item quantity | 1 |
| items.unit_amount | Y | String | Unit price | 1200.00 |
| items.tax_amount | N | Number | Tax amount for this item | 0 |
| items.discount_amount | N | Number | Discount amount for this item | 0 |
| items.currency_lookups_id | Y | String(32) | Currency lookup ID | loo_abc123... |
| items.metadata | N | JSON | Additional metadata for this item | {} |
| metadata | N | JSON | Any additional order metadata | {} |
| created_at | n/a | Datetime | Date and time record was created | 2024-02-27 09:11:23 |
Update
API call to update existing order(s) as single or batch records. Records can not be deleted, only archived.
Path
POST /orders/update
Request Body
Only include fields you wish to change (besides id used to find the record). Setting a column to null will clear that field's value if allowed
{
"records": [{
"id": "ord_abc123...",
"reference": "ORD0045",
"description": "Monthly plan + setup",
"amount_subtotal": "1100.00",
"amount_discount": "0.00",
"amount_shipping": "0.00",
"amount_tax": "100.00",
"amount_total": "1200.00",
"currency_lookups_id": "loo_abc123...",
"order_status_lookups_id": "loo_abc123...",
"fulfillment_status_lookups_id": "loo_abc123...",
"items": [
{
"sku": "SKU00567",
"name": "Pro Plan (Monthly)",
"quantity": 1,
"unit_amount": "1200.00",
"tax_amount": 0,
"discount_amount": 0,
"currency_lookups_id": "loo_abc123...",
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}
],
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}]
}
Response Body
{
"status": true,
"results": [{
"id": "ord_abc123...",
"reference": "ORD0045",
"description": "Monthly plan + setup",
"customer_id": "cus_abc123...",
"amount_subtotal": "1100.00",
"amount_discount": "0.00",
"amount_shipping": "0.00",
"amount_tax": "100.00",
"amount_total": "1200.00",
"currency_lookups_id": "loo_abc123...",
"order_status_lookups_id": "loo_abc123...",
"fulfillment_status_lookups_id": "loo_abc123...",
"items": [
{
"sku": "SKU00567",
"name": "Pro Plan (Monthly)",
"quantity": 1,
"unit_amount": "1200.00",
"tax_amount": 0,
"discount_amount": 0,
"currency_lookups_id": "loo_abc123...",
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}
],
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
},
"deleted_at": null,
"updated_at": "2024-02-27 09:11:23",
"created_at": "2024-02-27 09:11:23"
}]
}
Parameters
Field | Required | Type | Description | Example |
|---|---|---|---|---|
| id | Y | String(32) | Record id to update | ord_abc123... |
| reference | Y | String(35) | Reference to identify a specific order | ORD0045 |
| description | Y | String | Description of the order | Monthly plan + setup |
| customer_id | N | String(32) | Customer ID associated with this order | cus_abc123... |
| amount_subtotal | N | String | Subtotal amount before tax, shipping, and discounts | 1100.00 |
| amount_discount | N | String | Total discount amount applied | 0.00 |
| amount_shipping | N | String | Shipping cost amount | 0.00 |
| amount_tax | N | String | Tax amount applied | 100.00 |
| amount_total | Y | String | Total order amount including all fees | 1200.00 |
| currency_lookups_id | N | String(32) | Currency lookup ID for the order | loo_abc123... |
| order_status_lookups_id | N | String(32) | Order status lookup ID | loo_abc123... |
| fulfillment_status_lookups_id | N | String(32) | Fulfillment status lookup ID | loo_abc123... |
| items.sku | Y | String | Product SKU | SKU00567 |
| items.name | Y | String | Product name | Pro Plan (Monthly) |
| items.quantity | Y | Integer | Item quantity | 1 |
| items.unit_amount | Y | String | Unit price | 1200.00 |
| items.tax_amount | N | Number | Tax amount for this item | 0 |
| items.discount_amount | N | Number | Discount amount for this item | 0 |
| items.currency_lookups_id | Y | String(32) | Currency lookup ID | loo_abc123... |
| items.metadata | N | JSON | Additional metadata for this item | {} |
| metadata | N | JSON | Any additional order metadata | {} |
| created_at | n/a | Datetime | Date and time record was created | 2024-02-27 09:11:23 |
| updated_at | n/a | Datetime | Date and time record was last updated | 2024-02-27 09:11:23 |
List
List orders loaded on the platform.
Path
GET /orders/list?{params}
Query Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
| date_start | Date(YYYY-MM-DD) | N | Filter for records that have a created date after this date specified. | 2024-09-13 |
| date_end | Date(YYYY-MM-DD) | N | Filter for records that have a created date before this specified date | 2025-04-24 |
| order_id | String(32) | N | Filter for a specific order id. | ord_abc123... |
| order_reference | String(35) | N | Filter for a specific order reference. | ORD0045 |
| description | String | N | Filter for orders containing this description text. | Monthly plan |
| amount_total | String | N | Filter for orders with this total amount. | 1200.00 |
| order_status_lookups_id | String | N | Filter for orders status. | loo_abc123... |
| fulfillment_status_lookups_id | String | N | Filter for fulfillment status. | loo_abc123... |
Response Body
{
"status": true,
"results": [{
"id": "ord_abc123...",
"reference": "ORD0045",
"description": "Monthly plan + setup",
"customer_id": "cus_abc123...",
"amount_subtotal": "1100.00",
"amount_discount": "0.00",
"amount_shipping": "0.00",
"amount_tax": "100.00",
"amount_total": "1200.00",
"currency_lookups_id": "loo_abc123...",
"order_status_lookups_id": "loo_abc123...",
"fulfillment_status_lookups_id": "loo_abc123...",
"items": [
{
"sku": "SKU00567",
"name": "Pro Plan (Monthly)",
"quantity": 1,
"unit_amount": "1200.00",
"tax_amount": 0,
"discount_amount": 0,
"currency_lookups_id": "loo_abc123...",
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
}
}
],
"metadata": {
"custom_field_1": "custom data 1",
"custom_field_2": "custom data 2"
},
"updated_at": "2024-03-17 12:35:24",
"created_at": "2024-02-27 09:11:23"
}, {
...
}]
}
Mandates
Create and manage payment mandates for recurring transactions including DebiCheck and Registered Mandates. Handle mandate creation, authentication, status updates, and cancellation with full SARB compliance.
Checkout Page
Create a secure, customizable checkout page session to capture payments with cards, bank transfers, and other payment methods. Supports 3D Secure authentication, order management, customer creation, and webhook notifications.