Skip to main content

Create An Order

POST /api/v1/third-party/order/create

Content-Type: application/json

This method allows for the creation of an individual order within the Keepz system. The order will be active for 5 minutes from the time of creation.

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 (String, Required) - A unique identifier generated by the integrator's system.
    • uri (String, Required) - URI read from the QR.

Example:

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

{
    "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uniqueId": "d0e4782b-4caf-450a-86ed-8c9183c4f3fb",
    "uri": "https://appdev.keepz.me/pay?qrType=DEFAULT&receiverType=USER&receiverId=fc0088ac-d888-4792-8125-64eb9b25ed67" 
}

Parameters Returned:

  • encryptedData (String) - The details of the order encrypted with Keepz’s key. The encrypted value must contain the following parameters:
    • uniqueId (UUID) - A unique identifier within the integrator's system.
    • amount (Double) - The amount that needs to be paid (returned if the amount was specified in the QR or if the Keepz system can determine it based on the QR).
    • receiverName (String) - The name of the recipient.
    • status (String) - The status of the order. Possible values are:
      • REGISTERED (created in the Keepz system).
      • REJECTED (order rejected by the Keepz system).
    • minAmountAllowed (Double) - The minimum allowed amount (if the amount is returned by the Keepz system, this parameter will not be in the response).
    • maxAmountAllowed (Double) - The maximum allowed amount (if the amount is returned by the Keepz system, this parameter will not be in the response).
    • rejectReason (String) - Will be in the response if the status is REJECTED.

Example:

{
    "encryptedData": "string"
}

{
    "uniqueId": "d0e4782b-4caf-450a-86ed-8c9183c4f3fb",
    "Amount": 5.0,
    "receiverName": "firstName lastName",
    "status": "REGISTERED"
}