Export MPAY Cash Operations

Export MPay Cash Operations

This endpoint retrieves the MPAY cash operations (cashin/cashout) of a shop within a specified date range in JSON format.

GET mpay/export-operations/json?shop_uuid=<shop_uuid>&start_date=<start_date>&end_date=<end_date>&partner_request_id=<partner_request_id>

Authentication

• Add in the header:

Authorization: Basic <encoded_username_password_string>

Kenz'Up will provide a username and password which will be securely transmitted/communicated to the partner. The credentials should be base64 encoded in the format username:password.

Example: Authorization: Basic YWZyaXF1aTo5ODc2NTQzMjE=

Request Parameters:

Parameter	Type	Required	Description
shop_uuid	string	Yes	UUID of the shop to retrieve operations for
start_date	string	Yes	Start date for the query range (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)
end_date	string	Yes	End date for the query range (ISO 8601 format: YYYY-MM-DDTHH:MM:SS)
partner_request_id	string	No	Optional filter by specific partner request ID

Sample Request:

GET https://app.kenzup.com/api/v1/mpay/export-operations/json?shop_uuid=b5f6e9e3-6848-49cd-bcc0-726cbe99bf68&start_date=2023-08-27T00:00:00&end_date=2023-08-30T23:59:59&partner_request_id=REQ001

Headers:
Authorization: Basic YWZyaXF1aTo5ODc2NTQzMjE=

Response Parameters:

Parameter	Type	Description
created_at	string	Timestamp when the operation was created (ISO 8601 format)
partner_time	string	Timestamp from partner system (ISO 8601 format)
operation_type	string	Type of operation: cashin, cashout, etc.
partner_request_id	string	Partner's unique request identifier
amount	decimal	Operation amount
status	string	Operation status: pending, approved, rejected, etc.

Sample Response (Success):

[
  {
    "created_at": "2023-08-27T14:30:00.123456+01:00",
    "partner_time": "2023-08-27T14:29:58.000000+01:00",
    "operation_type": "cashin",
    "partner_request_id": "REQ001",
    "amount": "100.00",
    "status": "approved"
  }
]

Sample Response (No Operations Found):

{
  "message": "No existing operation within the requested parameters"
}

Sample Error Response:

{
  "detail": "Invalid shop UUID"
}

Notes:

• All timestamps are returned in ISO 8601 format with timezone information
• The end_date must be after the start_date
• Operations are returned in descending order by created_at
• If partner_request_id is provided, only operations matching that ID will be returned
• If partner_request_id is an empty string, it will be ignored (same as not providing it)
• Maximum date range and result limits may apply based on system configuration