Skip to main content
POST
/
v1
/
links
cURL
curl --request POST \
  --url https://api.nomod.com/v1/links \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "currency": "<string>",
  "items": [
    {
      "name": "<string>",
      "amount": "<string>",
      "quantity": 500
    }
  ],
  "title": "<string>",
  "note": "<string>",
  "discount_percentage": 0,
  "shipping_address_required": false,
  "allow_tip": false,
  "custom_fields": [
    {
      "name": "<string>"
    }
  ],
  "success_url": "<string>",
  "failure_url": "<string>",
  "allow_tabby": true,
  "allow_tamara": true,
  "allow_service_fee": true,
  "payment_expiry_limit": 2,
  "expiry_date": "2023-12-25"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reference_id": "<string>",
  "title": "<string>",
  "url": "<string>",
  "amount": "<string>",
  "currency": "<string>",
  "status": "enabled",
  "discount": "<string>",
  "service_fee": "<string>",
  "allow_tip": true,
  "shipping_address_required": true,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "amount": "<string>",
      "name": "<string>",
      "total_amount": "<string>",
      "quantity": 2147483647,
      "sku": "<string>"
    }
  ],
  "tax": "<string>",
  "note": "<string>",
  "taxes": [
    {
      "name": "<string>",
      "mode": "<string>",
      "mode_value": "0.000",
      "value": "0.000"
    }
  ],
  "discount_percentage": 123,
  "service_fee_percentage": "<string>",
  "tip": "<string>",
  "tip_percentage": 123,
  "due_date": "2023-11-07T05:31:56Z",
  "custom_fields": [
    {
      "name": "<string>",
      "is_required": true
    }
  ],
  "source": "nomod_hosted",
  "allow_tabby": true,
  "allow_tamara": true,
  "allow_service_fee": true,
  "payment_expiry_limit": 123,
  "expiry_date": "2023-12-25"
}

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

application/json
​
currency
string
required

ISO 4217 currency code for the link. Retrieve codes from the /currencies endpoint.

Maximum length: 3
​
items
object[]
required

List of items associated with this link, including name and amount.

​
title
string

Craft a beautiful name for your link

Maximum length: 50
​
note
string | null

Type out a quick note describing what you're selling

Maximum length: 280
​
discount_percentage
integer
default:0

Discount percentage.

Required range: 0 <= x <= 100
​
shipping_address_required
boolean
default:false

Whether shipping address is required.

​
allow_tip
boolean
default:false

Allow tips.

​
custom_fields
object[] | null

Custom fields to add. Maximum of 5 allowed

​
success_url
string<uri>

URL to redirect to upon successful transaction completion

​
failure_url
string<uri>

URL to redirect to if the transaction fails.

​
allow_tabby
boolean

Whether to enable Tabby payment method for the link. Default == true

​
allow_tamara
boolean

Whether to enable Tamara payment method for the link. Default == true

​
allow_service_fee
boolean

Whether to enable service fee for the link. Default == true

​
payment_expiry_limit
integer

Set number of payments as link expiry. Link will auto-expire after the set number of payments expiry is reached. Note: Only one parameter can be set at one time, either payment_expiry_limit or expiry_date

Required range: x >= 1
​
expiry_date
string<date>

Set any of the future date as the expiry date. Link will auto expire at the end of the day (11:59 PM) of the set expiry date. Note: Only one parameter can be set at one time, either payment_expiry_limit or expiry_date

Response

​
id
string<uuid>
required
​
reference_id
string
required
​
title
string
required
​
url
string<uri>
required
​
amount
string<decimal>
required
​
currency
string
required
​
status
enum<string>
required
  • enabled - enabled
  • disabled - disabled
Available options:
enabled,
disabled
​
discount
string<decimal>
required
​
service_fee
string<decimal>
required
​
allow_tip
boolean
required
​
shipping_address_required
boolean
required
​
items
object[]
required
​
tax
string<decimal>
required
​
note
string
required
​
taxes
object[]
required
​
discount_percentage
integer
required
​
service_fee_percentage
string<decimal>
required
​
tip
string<decimal>
required
​
tip_percentage
integer
required
​
due_date
string<date-time>
required
​
custom_fields
object[]
required
​
source
enum<string>
required
  • nomod_hosted - Nomod Hosted
  • woocommerce - WooCommerce
  • shopify - Shopify
  • zapier - Zapier
  • nomod_api - API
  • store - Store
  • app - App
  • web - Web
Available options:
nomod_hosted,
woocommerce,
shopify,
zapier,
nomod_api,
store,
app,
web
​
allow_tabby
boolean
required
​
allow_tamara
boolean
required
​
allow_service_fee
boolean
required
​
payment_expiry_limit
integer | null
required
​
expiry_date
string<date> | null
required
⌘I