Developers
HomeMerchantsDevelopers

Update Order Collection Status API

This API allows merchants to update and retrieve the collection status of an order within the N-Genius platform

This streamlined access ensures real-time order tracking and efficient management of inventory and fulfillment, improving overall operational efficiency.

1. Update Collection Status

Endpoint (POST):

https://api-gateway.sandbox.ngenius-payments.com/transactions/outlets/{{OutletRef}}/orders/{{order_reference}}/payments/{{payment_reference}}/collection-status

Headers:

Authorization: Bearer {{access_token}}
Content-Type: application/vnd.ni-payment.v2+json
Accept: application/vnd.ni-payment.v2+json

Request Body:

{
  "collectionStatus": "COLLECTED"
}

Response Example:

{
  "collectionStatus": "COLLECTED",
  "timestamp": "2025-07-08T08:50:56.153924338Z"
}

2. Retrieve Collection Status

Endpoint (GET):

https://api-gateway.sandbox.ngenius-payments.com/reporting/outlets/{{OutletRef}}/orders/{{order_ref}}

Headers:

Authorization: Bearer {{access_token}}
Accept: application/vnd.ni-reporting.v3+json
Content-Type: application/vnd.ni-reporting.v3+json

Response Example:

{
  "_embedded": {
    "events": [
      {
        "metaData": {},
        "eventGroupType": "COLLECTION_STATUS",
        "eventName": "COLLECTION_STATUS_UPDATED",
        "status": "SUCCESS",
        "timestamp": "2025-07-08T08:50:56.153924338Z",
        "payload": {
          "reference": "07302d38-bf14-430f-9ac3-ce953bbaad80",
          "orderResource": "http://transaction-service/transactions/outlets/dcc27267-8c42-423c-b86c-fbf93792e45a/orders/07302d38-bf14-430f-9ac3-ce953bbaad80",
          "collectionStatus": "COLLECTED",
          "outletId": "dcc27267-8c42-423c-b86c-fbf93792e45a",
          "paymentReference": "1ed60e2f-8008-456f-aca4-25fdee143b1c",
          "tenantRef": "08c6e5b3-4158-4432-9974-0a27288a43d5",
          "orderStatus": "CLOSE",
          "userName": "Test account",
          "userRole": "MERCHANT_SYSTEMS"
        },
        "outletId": "dcc27267-8c42-423c-b86c-fbf93792e45a",
        "outletName": "Boutique Fashion",
        "reversedAmountValue": 0
      }
    ]
  }
}

Tools for Testing

Click below to open the official Order Status Postman API Collection.

Learn More

Merchants can also update and view the collection status directly from the N-Genius portal. To learn more about this feature and how it works in the dashboard, visit:

Order Fulfilment Status – Merchant Guide

Ready for your two small bonuses whenever you are, me matey! 🏴‍☠️