Currency: All amounts are in Naira (NGN).

Retrieves the details of an existing order using the client-provided reference. The response includes order status and voucher details.

Note: For orders created with recipients, vouchers are also delivered to the recipients' email addresses.

If the order is not found, a status code defined in the SureGifts API status codes will be returned.

Request

Method: GET
URL: /v2/orders/{reference}
Path Parameters:

• reference (string, required) – Your unique order reference.

Example URL:

https://{baseUrl}/v2/orders/123456789

Responses

200 OK – Successful

Field Descriptions:

• data.orderNumber (string) – SureGifts order reference number.
• data.reference (string) – The client-provided reference.
• data.status (string) – Current voucher status. Possible values: FAILED, CANCELED, COMPLETED, PARTIALLY_COMPLETED, PROCESSING.
• data.vouchers (array | null) – List of vouchers created from the order. Not included when Download orders have status PROCESSING. The voucher schema varies based on order type (Download vs Recipients).
  • value (double) – Initial voucher value.
  • serial (number) – Voucher serial number.
  • code (string) – Voucher code. Included for Download orders only.
  • pin (string) – Voucher redemption PIN. Included for Download orders only.
  • expiryDate (date-time | null) – Voucher expiry date. Technically, vouchers don't expire; the system automatically extends the date by 1 year. Included for Download orders only.
  • status (string | null) – Item delivery status. Possible values: FAILED, CANCELED, DELIVERED, PROCESSING. Included for Recipient orders only.
  • firstName (string | null) – Recipient first name. Included for Recipient orders only.
  • lastName (string | null) – Recipient last name. Included for Recipient orders only.
  • email (string | null) – Recipient email address. Included for Recipient orders only.
• statusCode (string) – Request status code ("00" indicates success).
• message (string | null) – Human-readable description of the status code.

Example – Completed

{
    "data": {
        "orderNumber": "002104",
        "reference": "784",
        "status": "COMPLETED",
        "vouchers": [
            {
                "value": 500.00,
                "expiryDate": "2026-08-14T19:53:26.320451Z",
                "pin": "0000",
                "code": "262256943944",
                "serial": 300002722
            }
        ]
    },
    "statusCode": "00",
    "message": "Successful"
}

Order Not Found

Returns a non-00 status code as defined in the SureGifts API status codes documentation.

{
    "statusCode": "04",
    "message": "Order not found"
}

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

500 Internal Server Error

Internal Server Error

Example cURL Request

curl -X GET \
  'https://{baseUrl}/v2/orders/123456789' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'