Finalizing An Order

PUT /api/v1/third-party/order/finalize

Content-Type: application/json

To ensure that the Keepz system executes a payment initiated by the integrator, it is necessary for the integrator to provide the final status of the already created order to the Keepz system. The delivery of the final status must occur within 5 minutes of creation. Otherwise, the order will be considered canceled.

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.
  • amount (Double, Required) - The amount that needs to be paid. If the amount was returned to the integrator in the response to the creation order by the Keepz system, the integrator must send the same amount in this parameter.
  • finalStatus (String, Required) - The final status within the integrator's system.
    • SUCCESS (successfully completed within the integrator's system). The Keepz system must process the payment.

Example:

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

{
    "identifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "uniqueId": "d0e4782b-4caf-450a-86ed-8c9183c4f3fb",
    "Amount": 5.0,
    "finalStatus":" SUCCESS"
}

Parameters Returned:

• encryptedData (String) - The details of the order encrypted with Keepz’s key. The encrypted value must contain the following parameters:
  • uniqueId (UUID) - The identifier of the order within the integrator's system.
  • Status (String) - The status of the order completion:
    • SUCCESS - The order was completed successfully, and the funds will be transferred to the beneficiary only in this case.
    • ALREADY_FINALISED - The order has already been completed.
    • ORDER_NOT_FOUND - The order was not created or expired due to inactivity.
    • RECEIVER_REACHED_LIMIT - The recipient has reached the limit in the Keepz system.
    • AMOUNT_NOT_IN_RANGE - The order amount is less than the minimum limit or exceeds the maximum limit.
    • WRONG_AMOUNT - The integrator sent a different amount in the order for completion than what was returned by the Keepz system.

Example:

{
    "encryptedData": "string"
}

{
    "uniqueId": "8ab2df0b-c749-4a68-bf3c-1179d17b83a4",
    "status": "SUCCESS"
}