Skip to main content

Viewing Order Details

GET /api/v1/third-party/order/details

Parameters:

  • Identifier (UUID, Required) - The Integrator’s identifier within the Keepz system (provided by a representative of Keepz).
  • encryptedData (String, Required) - The details of the order encrypted with the integrator's key. The encrypted value must contain the following parameters:
    • identifier (UUID, Required) - The Integrator’s identifier within the Keepz system.
    • uniqueId (UUID, Required) - The identifier of the order within the integrator's system.

Example:

{
    "encryptedData": "string",
    "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
    "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uniqueId": "8ab2df0b-c749-4a68-bf3c-1179d17b83a4"
}

Parameters Returned:

  • encryptedData (String) - The details of the order encrypted with Keepz’s key. The encrypted value must contain the following parameters:
    • uniqueId (String) - A unique identifier within the integrator's system.
    • amount (Double) - The amount.
    • status (String) - The status of the order. Possible values are:
      • REGISTERED (created in the Keepz system).
      • SUCCESS (successfully completed).
      • FAILED (unsuccessfully completed in the Keepz system).
    • createdAt (DateTime) - The creation time of the order.
    • finalisedAt (DateTime) - The last update time (completion time).