Skip to main content
POST
/
v1
/
checkout
cURL
curl --request POST \
  --url https://api.nomod.com/v1/checkout \
  --header 'Content-Type: */*' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "reference_id": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "items": [
    {
      "item_id": "<string>",
      "name": "<string>",
      "quantity": 1,
      "unit_amount": "<string>",
      "discount_type": "flat",
      "discount_amount": "0.00",
      "total_amount": "<string>",
      "net_amount": "<string>"
    }
  ],
  "discount": "0.00",
  "customer": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "phone_number": "<string>",
    "business_name": "<string>"
  },
  "success_url": "<string>",
  "failure_url": "<string>",
  "cancelled_url": "<string>",
  "metadata": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "status": "paid",
  "amount": 123,
  "discount": 123,
  "currency": "<string>",
  "reference_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "items": [
    {
      "item_id": "<string>",
      "name": "<string>",
      "quantity": 1,
      "unit_amount": "<string>",
      "discount_type": "flat",
      "discount_amount": "0.00",
      "total_amount": "<string>",
      "net_amount": "<string>"
    }
  ],
  "customer": {
    "first_name": "",
    "last_name": "",
    "business_name": "",
    "email": "",
    "phone_number": ""
  },
  "metadata": {},
  "charges": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": 123,
      "payment_time": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payment_method": "cash",
      "status": "authorised"
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Your API key. This is required by all endpoints to access our API programatically. You can view your API Key by navigating to the app settings

Body

*/*
​
reference_id
string
required

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar. Merchants can use it to reconcile the session with their internal systems

Maximum length: 100
​
amount
string<decimal>
required

The total payable amount (after applying discounts) in the main currency unit (e.g., USD, AED)

​
currency
string
required

Currency code (ISO 4217 format, e.g., USD, INR, AED)

Maximum length: 3
​
items
object[]
required

A list of items the customer is buying, including item-level details

​
success_url
string<uri>
required

URL where the customer should be redirected after payment success

​
failure_url
string<uri>
required

URL where the customer should be redirected if the payment fails

​
cancelled_url
string<uri>
required

URL where the customer should be redirected if they cancel payment

​
discount
string<decimal>
default:0.00

The total discount amount applied to the order. Provide the value in the main currency unit (e.g., USD, AED)

​
customer
object

Customer object with customer-related details

​
metadata
object

A set of key-value pairs that merchants can attach to an object. This can be useful for storing additional information about the object in a structured format.Maximum of 40 pairs allowed. Keys must be alphanumeric and cannot contain square brackets ([ and ]). Keys must not exceed 24 characters, and values must not exceed 512 characters.

Response

​
id
string<uuid>
required
​
url
string<uri>
required

The URL to the Checkout Session. Redirect customers to this URL to take them to the Hosted Checkout page

​
status
enum<string>
required

Status of the session: created, cancelled, expired, paid

Available options:
paid,
created,
cancelled,
expired
​
amount
number
required

The total payable amount (after applying discounts) in the main currency unit (e.g., USD, AED)

​
discount
number
required

The total discount amount applied to the order. Provide the value in the main currency unit (e.g., USD, AED)

​
currency
string
required

Currency code (ISO 4217 format, e.g., USD, INR, AED)

Maximum length: 3
​
reference_id
string
required

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and merchants can use it to reconcile the session with their internal systems

​
created_at
string<date-time>
required

ISO 8601 timestamp when the checkout session was created

​
items
object[]
required

A list of items the customer is buying, including item-level details

​
customer
object
required

Customer object with customer-related details

​
metadata
object
required

A set of key-value pairs that merchants can attach to an object. This can be useful for storing additional information about the object in a structured format.Maximum of 40 pairs allowed. Keys must be alphanumeric and cannot contain square brackets ([ and ]). Keys must not exceed 24 characters, and values must not exceed 512 characters.

​
charges
object[]
required

List of charges associated with the checkout

⌘I