Get Order Status

The Order Status endpoint is used to verify the current status of an order or payment. This helps determine whether to proceed with fulfilling the customer's request (e.g., granting access, delivering value).

ℹ️

The payload must be encrypted using RSA PKCS#1 v1.5 before making the request.

Payload Structure (Before Encryption)

Key	Type	Description	Required
reference	string	The unique reference of the order to check	✅

---

Encryption Requirements

• Encrypt the payload using RSA PKCS#1 v1.5.
• Base64-encode the encrypted result.
• Use the public key provided by TransactPay.
• Follow our guide to implement this Encryption

---

Sample Raw Payload (Before Encryption)

JSON

{
  "reference": "ORDER123456"
}

---

Final Request Payload Format

JSON

{
  "data": "{{encrypteddata}}"
}

• data: Base64-encoded RSA PKCS#1 v1.5 encrypted string of the JSON payload.

---

Response

JSON

{
  "status": "Successful",
  "statusCode": "00",
  "message": "Successful",
  "data": {
    "isFinalStatus": true,
    "requeryNeeded": false,
    "requeryType": null,
    "orderSummary": {
      "id": 26,
      "paymentReference": "IDSPAY-76279490-6B08-45CF-9919-582E9C77F52B",
      "orderReference": "754874724",
      "totalChargedAmount": 114,
      "fee": 14,
      "statusId": 5,
      "status": "Successful",
      "paymentType": "C",
      "currencyId": 1,
      "paymentResponseCode": "00",
      "paymentResponseMessage": "Successful",
      "providerResponseDate": null,
      "datePaymentConfirmed": null,
      "dateCreated": "2024-03-31T14:05:46.37",
      "narration": "Pay",
      "remarks": "Order initiated and created successfully"
    },
    "orderPayments": [
      {
        "orderId": 26,
        "orderPaymentReference": "PGW-PAYREF-96C2ABCB218C43329037E47268F74195",
        "paymentOptionId": 2,
        "statusId": 5,
        "orderPaymentResponseCode": "00",
        "orderPaymentResponseMessage": "Successful",
        "orderPaymentInstrument": null,
        "remarks": "Order payment initiated",
        "providerReference": "CPF046D30F-3F82-4A9A-B2AD-AC5AE3480D8F",
        "providerResponseCode": "02",
        "paymentUrl": "https://core-api-service.ideospay.dev/web/card/authorize/CPF046D30F-3F82-4A9A-B2AD-AC5AE3480D8F/initiate",
        "externalReference": "N/A",
        "authOption": null,
        "order": null,
        "id": 18,
        "dateCreated": "2024-03-31T14:08:30.6525848",
        "dateUpdated": "2024-03-31T14:08:51.3048026",
        "dateDeleted": null,
        "createdBy": -1,
        "updatedBy": -1,
        "deletedBy": null
      }
    ]
  }
}

JSON

{
    "data": "{{encrypteddata}}"
}