Get order status

---

GET /api/integrator/order/status

This GET method is used to check the current status of a specific order in Keepz.

Request details

When sending request to Keepz, these four parameters must always be included in the query parameters:

identifier

• Unique ID of the integrator in the Keepz system.
• Provided by Keepz during the integration process.

encryptedData

• Contains the actual request payload encrypted using a randomly generated symmetric key and IV (Initialization Vector).

encryptedKeys

• Contains the AES key and IV used to encrypt encryptedData.

aes

• Boolean flag indicating that the request uses AES-based symmetric encryption (needed for backward compatibility with older encryption methods).

For details on the encryption process, see the Encryption Guide documentation.

Parameters

The following parameters form the actual order payload. They must be included inside the encryptedData parameter, which is encrypted and passed in the request as shown above.

Parameter	Type	Required	Description	Possible values	Note
integratorId	string (UUID v4 format)	✅	Unique ID of the integrator in the Keepz system. Provided to the integrator by a Keepz representative.
integratorOrderId	string (UUID v4 format)	✅	Unique ID of order in the integrator’s system.

Response details

✅ Success Response

If the request is valid, the API returns an encrypted payload:

{
  "encryptedData": "string",
  "encryptedKeys": "string",
  "aes": true
}

encryptedData

• Contains the actual response payload encrypted using a randomly generated symmetric key and IV (Initialization Vector).

encryptedKeys

• Contains the AES key and IV used to encrypt encryptedData.

aes

• Boolean flag indicating that the request uses AES-based symmetric encryption (needed for backward compatibility with older encryption methods).

For details on the decryption process, see the Encryption Guide documentation.

Inside encryptedData, the following parameters are available after decryption:

Parameter	Type	Possible Values / Format	Description
integratorOrderId	string(UUID v4)		Unique identifier of the order in the integrator’s system.
status	string	INITIAL, PROCESSING, SUCCESS, FAILED, CANCELED, EXPIRED, REFUND_REQUESTED,PARTIALLY_REFUNDED,REFUNDED_BY_OPERATOR, REFUNDED_BY_INTEGRATOR, REFUNDED_BY_KEEPZ, REFUNDED_FAILED	Current status of the order in Keepz system.

Order Status Reference

Status	Description
INITIAL	The order has been created but payment has not yet started.
PROCESSING	The payment process is in progress (e.g., awaiting user action, bank authorization, or third-party provider confirmation).
SUCCESS	The payment was completed successfully, and the funds were captured.
FAILED	A payment attempt was made, but it did not succeed (e.g., insufficient funds, card declined, technical error).
CANCELED	The order was canceled before completion (by integrator or system).
EXPIRED	The order remained unpaid and no payment attempt was made within the validity period defined by Keepz. Once expired, the order can no longer be processed.
REFUND_REQUESTED	A refund request has been submitted but not yet processed.
PARTIALLY_REFUNDED	The order has been partially refunded — only part of the total amount was returned to the customer.
REFUNDED_BY_INTEGRATOR	The order has been refunded by the integrator
REFUNDED_BY_KEEPZ	The order has been refunded by Keepz.
REFUNDED_FAILED	The order refund has failed.

❌ Error Response

If an error occurs, the response is returned without encryption (plain JSON):

{
  "message": "Integrator order not found",
  "statusCode": 6005,
  "exceptionGroup": 5
}

Parameter	Type	Description
message	string	Error message. Details are provided in the dedicated section below.
statusCode	number	Error status code. Details are provided in the dedicated section below.
exceptionGroup	number	Error group. Details are provided in the dedicated section below.

Details can be found at Error Code Description.