No Show

To create a No Show unscheduled transaction, the No Show service must be enabled for the merchant. This feature is applicable only to Unscheduled Purchases. The No Show flow is used when an initial amount is charged upfront, and the remaining amount is scheduled to be charged later. If the customer fails to show up by the specified noShowStartTime, the merchant is allowed to charge No Show fees, calculated as the difference between noShowAmount and the initially charged amount.

HTTP Request Method: POST
Resource (URI): https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/{outletId}/orders

Headers:

Add these headers to your request (note that you should replace 'access_token' with the access token value we received from the Request an access token step).

HeaderValue
AuthorizationBearer access_token
Content-Typeapplication/vnd.ni-payment.v2+json
Acceptapplication/vnd.ni-payment.v2+json

Body:

Add the following JSON information to the form/body content of your request.

AttributeDescriptionExample
actionPayment processing method'PURCHASE'
typeType of payment requested'UNSCHEDULED'
frequencyFrequency/interval of paymentVarious (see below)
emailAddressCustomer email address[email protected]
amountamount data blockN/A
amount.currencyCodeOrder currency'SAR'
amount.valueInitial amount1000 ( = 10.00 SAR)
noShowDetailsnoShowDetails data blockN/A
noShowDetails.totalAmountTotalAmount data blockN/A
noShowDetails.totalAmount.currencyCodeOrder currency'SAR'
noShowDetails.totalAmount.valueTotal amount value2000 ( = 20.00 SAR)
noShowDetails.noShowAmountnoShowAmount data block
noShowDetails.noShowAmount.currencyCodeOrder currency'SAR'
noShowDetails.noShowAmountNo Show amount value1500 ( = 15.00 SAR)
noShowDetails.noShowStartTimeNo Show start time2025-04-21T12:00:00

No Show Details:

totalAmount:

Total order amount is passed in this field. The amount field in order request will specify the initial amount to be charged. Once the initial transaction is successful, merchant can trigger subsequent order api to charge the remaining amount (i.e. totalAmount - amount)

noShowAmount:

No Show amount is passed in this field. Once the initial transaction is completed, and the noShowStartTime has passed, merchant can trigger noShow to capture the No Show penalty amount (i.e. noShowAmount - amount). No Show amount must be greater than amount and less than equal to the totalAmount. To trigger noShow, merchant needs to call subsequent API with below body:

{
	"noShowIndicator": true
}

noShowStartTime:

The noShowStartTime field specifies a future date and time after which the merchant is permitted to charge the No Show fees.

Example request (body):

{
  "action": "PURCHASE",
  "type": "UNSCHEDULED",
  "emailAddress": "[email protected]",
  "amount": {
    "currencyCode": "SAR",
    "value": 10000
  },
  "noShowDetails": {
    "totalAmount": {
      "currencyCode": "SAR",
      "value": 20000
    },
    "noShowStartTime": "2025-09-21T12:00:00",
    "noShowAmount": {
      "currencyCode": "SAR",
      "value": 15000
    }
  }
}

Example response (body):

{
  "_id": "urn:order:04e2daff-11e8-4fb1-81af-131f0108f5ae",
  "_links": {
    "cnp:payment-link": {
      "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/payment-link"
    },
    "close-unscheduled": {
      "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/closeUnscheduled"
    },
    "payment-authorization": {
      "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/paymentAuthorization"
    },
    "self": {
      "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae"
    },
    "tenant-brand": {
      "href": "http://config-service/config/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/configs/tenant-brand"
    },
    "payment": {
      "href": "https://paypage.sandbox.ksa.ngenius-payments.com/?code=47eb50f60c4916e3"
    },
    "merchant-brand": {
      "href": "http://config-service/config/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/configs/merchant-brand"
    }
  },
  "type": "UNSCHEDULED",
  "merchantDefinedData": {},
  "action": "PURCHASE",
  "amount": {
    "currencyCode": "SAR",
    "value": 10000
  },
  "language": "en",
  "merchantAttributes": {},
  "emailAddress": "[email protected]",
  "reference": "04e2daff-11e8-4fb1-81af-131f0108f5ae",
  "outletId": "63ecfe89-f7b3-4a06-9e12-d218d772020d",
  "createDateTime": "2025-06-24T09:30:04.527379511Z",
  "paymentMethods": {
    "card": [
      "MASTERCARD",
      "VISA",
      "MADA"
    ]
  },
  "referrer": "urn:Ecom:04e2daff-11e8-4fb1-81af-131f0108f5ae",
  "merchantDetails": {
    "reference": "0b4dd17c-ec44-4f30-bef0-7890d91da22d",
    "name": "WestZone7812",
    "companyUrl": "",
    "email": "",
    "mobile": ""
  },
  "noShowDetails": {
    "totalAmount": {
      "currencyCode": "SAR",
      "value": 20000
    },
    "noShowStartTime": "2025-09-21T12:00:00",
    "noShowAmount": {
      "currencyCode": "SAR",
      "value": 15000
    }
  },
  "isSplitPayment": false,
  "isSaudiPaymentEnabled": true,
  "formattedOrderSummary": {},
  "formattedAmount": "SAR 100",
  "formattedOriginalAmount": "",
  "_embedded": {
    "payment": [
      {
        "_id": "urn:payment:01f7768e-0207-487e-a697-0f4cd7c19f58",
        "_links": {
          "close-unscheduled": {
            "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/closeUnscheduled"
          },
          "self": {
            "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/payments/01f7768e-0207-487e-a697-0f4cd7c19f58"
          },
          "payment:card": {
            "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/payments/01f7768e-0207-487e-a697-0f4cd7c19f58/card"
          },
          "payment:saved-card": {
            "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/transactions/outlets/63ecfe89-f7b3-4a06-9e12-d218d772020d/orders/04e2daff-11e8-4fb1-81af-131f0108f5ae/payments/01f7768e-0207-487e-a697-0f4cd7c19f58/saved-card"
          },
          "curies": [
            {
              "name": "cnp",
              "href": "https://api-gateway.sandbox.ksa.ngenius-payments.com/docs/rels/{rel}",
              "templated": true
            }
          ]
        },
        "reference": "01f7768e-0207-487e-a697-0f4cd7c19f58",
        "state": "STARTED",
        "amount": {
          "currencyCode": "SAR",
          "value": 10000
        },
        "updateDateTime": "2025-06-24T09:30:04.527379511Z",
        "outletId": "63ecfe89-f7b3-4a06-9e12-d218d772020d",
        "orderReference": "04e2daff-11e8-4fb1-81af-131f0108f5ae"
      }
    ]
  }
}

Response attributes:

AttributeDescriptionExample
referenceOrder reference[UUID]
outletIdThe reference of the outlet which accepted the payment[UUID]
noShowDetailsnoShowDetails data block

However, should you wish to interrogate the order further, you may use the 'orderReference' attribute to query the order in more detail (see Retrieve order status for more information on how to do this).