Retrieve order status

You may query the N-Genius Online APIs to retrieve the status/outcome of any order, at any time. Doing so will provide you not only with a full breakdown of the order object, but it will also provide easy-to-use links to any follow-up request you may wish to execute.

HTTP Request Method: GET
Resource (URI): https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/[outlet-reference]/orders/[order-reference]

Headers:

Header	Value
Authorization	Bearer [access_token]

Please note that, for the following request types (including this one), no message body data is required, since the HTTP method is either GET or DELETE:

retrieving an order status
executing authorization reversals
cancellation of captures
cancellation of refunds

Example response (body):

{
    "_id": "urn:order:cac88045-bec0-432a-8fdd-06902da874d2",
    "_links": {
        "cancel": {
            "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2/cancel"
        },
        "payment-authorization": {
            "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/paymentAuthorization"
        },
        "self": {
            "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2"
        },
        "tenant-brand": {
            "href": "http://config-service/config/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/configs/tenant-brand"
        },
        "payment": {
            "href": "https://paypage.sandbox.ngenius-payments.com/?code=3cb068fe2f6edeff"
        },
        "merchant-brand": {
            "href": "http://config-service/config/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/configs/merchant-brand"
        }
    },
    "type": "SINGLE",
    "merchantDefinedData": {},
    "action": "AUTH",
    "amount": {
        "currencyCode": "AED",
        "value": 12345
    },
    "language": "en",
    "merchantAttributes": {},
    "reference": "cac88045-bec0-432a-8fdd-06902da874d2",
    "outletId": "670bfc06-63d6-472b-af75-ad0207ac44f5",
    "createDateTime": "2025-04-15T08:25:08.171027365Z",
    "paymentMethods": {
        "card": [
            "VISA",
            "MASTERCARD"
        ],
        "wallet": [
            "SAMSUNG_PAY"
        ]
    },
    "referrer": "urn:Ecom:cac88045-bec0-432a-8fdd-06902da874d2",
    "merchantDetails": {
        "reference": "84f95da6-1898-4799-bd36-25df22207e13",
        "name": "Squeaky Chair Productions",
        "companyUrl": "https://network.ae"
    },
    "isSplitPayment": false,
    "formattedOriginalAmount": "",
    "formattedOrderSummary": {},
    "formattedAmount": "د.إ.‏ 123.45",
    "_embedded": {
        "payment": [
            {
                "_id": "urn:payment:b0d21130-f683-442a-b7b3-397461374cdf",
                "_links": {
                    "cnp:3ds2-challenge-response": {
                        "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2/payments/b0d21130-f683-442a-b7b3-397461374cdf/card/3ds2/challenge-response"
                    },
                    "self": {
                        "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2/payments/b0d21130-f683-442a-b7b3-397461374cdf"
                    },
                    "cnp:3ds2-authentication": {
                        "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2/payments/b0d21130-f683-442a-b7b3-397461374cdf/card/3ds2/authentications"
                    },
                    "cnp:3ds": {
                        "href": "https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/670bfc06-63d6-472b-af75-ad0207ac44f5/orders/cac88045-bec0-432a-8fdd-06902da874d2/payments/b0d21130-f683-442a-b7b3-397461374cdf/card/3ds"
                    },
                    "curies": [
                        {
                            "name": "cnp",
                            "href": "https://api-gateway.sandbox.ngenius-payments.com/docs/rels/{rel}",
                            "templated": true
                        }
                    ]
                },
                "reference": "b0d21130-f683-442a-b7b3-397461374cdf",
                "paymentMethod": {
                    "expiry": "2029-04",
                    "cardholderName": "John Brown",
                    "name": "VISA",
                    "pan": "411111******1111"
                },
                "state": "AWAIT_3DS",
                "amount": {
                    "currencyCode": "AED",
                    "value": 12345
                },
                "updateDateTime": "2025-04-15T08:25:10.757199051Z",
                "outletId": "670bfc06-63d6-472b-af75-ad0207ac44f5",
                "orderReference": "cac88045-bec0-432a-8fdd-06902da874d2",
                "originIp": "196.5.8.18",
                "3ds2": {
                    "messageVersion": "2.1.0",
                    "threeDSMethodURL": "https://paypage-uat.ngenius-payments.com/fake/3ds2/method",
                    "threeDSServerTransID": "da6802ce-15cd-4631-9238-b81b0a08a6aa",
                    "directoryServerID": "M000000004"
                },
                "mid": "10089865858"
            }
        ]
    }
}