Skip to main content
POST
/
nomupay
/
create-order
Create NOMU Pay order or process completed order
curl --request POST \
  --url https://api.sprucecollective.co.uk/nomupay/create-order \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "brands": [
    "<string>"
  ],
  "cancel_url": "<string>",
  "completed_at": "<string>",
  "confirmation_only": true,
  "created_at": "<string>",
  "currency": "<string>",
  "custom_data": {},
  "customer_email": "<string>",
  "customer_name": "<string>",
  "customer_phone": "<string>",
  "description": "<string>",
  "entity_id": "<string>",
  "failure_url": "<string>",
  "integrity": true,
  "item_id": "<string>",
  "metadata": {},
  "order_id": "<string>",
  "payment_brand": "<string>",
  "payment_id": "<string>",
  "payment_type": "<string>",
  "quantity": 123,
  "redirect_url": "<string>",
  "result_code": "<string>",
  "site_id": "<string>",
  "status": "<string>",
  "success_url": "<string>",
  "upsells": [
    {
      "discount": 123,
      "percentage": 123,
      "qty": 123,
      "quantity": 123
    }
  ],
  "user_exists": true,
  "user_id": "<string>",
  "utm": "<string>",
  "utm_campaign": "<string>",
  "utm_content": "<string>",
  "utm_medium": "<string>",
  "utm_params": {},
  "utm_source": "<string>",
  "utm_term": "<string>"
}
'
{
  "checkout_id": "<string>",
  "environment": "<string>",
  "error": "<string>",
  "error_code": "<string>",
  "integrity": "<string>",
  "message": "<string>",
  "order_id": "<string>",
  "order_state": "<string>",
  "payment_id": "<string>",
  "status": "<string>",
  "success": true
}

Body

application/json

Order data or completed order data

amount
number
brands
string[]
cancel_url
string
completed_at
string
confirmation_only
boolean

Email control

created_at
string
currency
string
custom_data
object
customer_email
string
customer_name
string
customer_phone
string
description
string
entity_id
string

COPYandPAY specific fields

failure_url
string
integrity
boolean
item_id
string
metadata
object
order_id
string

Order completion data (when frontend handles checkout)

payment_brand
string

Additional NomuPay fields

payment_id
string
payment_type
string
quantity
integer

Legacy order creation fields (for backward compatibility)

redirect_url
string
result_code
string
site_id
string
status
string
success_url
string
upsells
object[]

Upsells and UTM parameters

user_exists
boolean
user_id
string
utm
string

UTM fields

utm_campaign
string
utm_content
string
utm_medium
string
utm_params
object
utm_source
string
utm_term
string

Response

OK

checkout_id
string
environment
string
error
string
error_code
string
integrity
string
message
string
order_id
string
order_state
string
payment_id
string

Order completion response

status
string
success
boolean