Fetch Request Details Using DateTime and AccountNumber

This function is used by merchants to fetch multiple payments based on time and specific virtual account Number generated for the merchant.

This will allow merchants to fetch a list of payments paid in a particular period.

Parameters

Headers

Header	Value	Required
Authorization	Bearer <Bearer_Token> Generated during the authenticate request	Yes
Content-Type	application/json	Yes
apikey	app consumer key	Yes

Request

Parameter Name	Type	Description	Required
service_code	string	A unique code identifier for the merchant's service in use as provided on the checkout platform.	Yes
from_date	string	Start date when you want to query for a transaction. Date format (YYYY-DD-MM H:I:S) in UTC time.	Yes
to_date	string	End date when you want to query for a transaction. Date format (YYYY-DD-MM H:I:S) in UTC time.	Yes
account_number	string	Virtual account in case of static account or merchant accountNumber you can use to query successful payments or unprocessed payments.	No
status	string	Indicating status of which type of transactions you need to pull for i.e all – pull both successful, expired and pending. pending - pull only transactions that have been paid but not processed.	No

Request Body

{
  "service_code": "SOLANKIFIRM",
  "from_date": "2022-02-15 14:35:43",
  "to_date": "2022-02-16 10:47:16",
  "account_number": "101",
  "status": "all"
}

Response

Parameter Name	Type	Description
status	JSONObject	Contains status code and description.
status_code	integer	The response status code.
status_description	string	Exact description of the status.
results	array	Null when request fails
checkout_request_id	integer	The unique request identifying the transaction logged in the checkout platform.
merchant_transaction_id	string	The unique transaction ID from merchant's system identifying the request.
request_status_code	integer	A code identifying the status of the request i.e paid, unpaid expired etc. A list of available status codes will be provided below.
request_status_description	string	A description of the requestStatusCode providing more information about the status.
currency_code	string	The currency code used in the transaction.
request_amount	double	The amount that the merchant needed to charge the customer for items selected on their platform.
amount_paid	double	This is the total amount paid for at the time of fetching the checkout request status. More details of the payments can be found in the payments array as will be provided below.
account_number	string	An identifier for the account being paid for as posted in the checkout initiation leg.
msisdn	string	The mobile number that the checkout request was originally initiated with.
payments	array

The payments parameter holds a list of payments that have been made for the current request.

Parameter Name	Type	Description
msisdn	string	The mobile number that the payment originated from.
payment_id	integer	The unique payment request identifying the transaction logged in the checkout platform.
checkout_request_id	integer	The unique request identifying the transaction logged in the checkout platform.
cpg_transaction_id	string	A unique identifier to identify the payment on the Cellulant's payment Gateway
payer_transaction_id	string	A unique identifier of the payment as logged on the payment channel's platform. This may be logged by the merchant for easier transaction tracking and support for customers.
account_number	string	An identifier for the account being paid for as posted in the checkout initiation leg.
customer_name	string	Name of the payer originating customer.
amount_paid	double	A numerical value of the payment amount i.e. the amount received from the payment channel the customer paid from
merchant_receipt	string	Unique identifier of the acknowledgement response given back.
payer_narration	string	Description of payment provided by the payment option.
receiver_narration	string	Description of payment provided by merchant on acknowledgment.
hub_overall_status	integer	Payment status on the Cellulant Payment Gateway.
status_code_desc	string	Description of the hubOverallStatus.
payer_client_code	string	Unique code of the payment option on the Tingg checkout platform.
payer_client_name	string	The name provided for the payment option on the Tingg checkout platform.
owner_client_code	string	Unique merchant code on the Tingg checkout platform.
owner_client_name	string	Merchants name on the Tingg checkout platform.
merchant_transaction_id	string	Unique identifier from the merchant concerning the request raised to Cellulant.
converted_amount	double	Current amount of the converted currency the payment should be made for.
total_payable_amount	double	Amount the customer can actually pay for the request.
date_payment_received	string	The date in which the payment was logged onto the cellulant payment gateway.
date_payment_acknowledged	date	Date when the payment was acknowledged.
date_created	date	Date when the payment was initiated.
currency_code	string	A three characters currency code (ISO 4217) that the payment originated.
country_code	string	A three characters country code (ISO KEN) that the payment originated.

Processing Status Codes

Status Code	Status Description
200	Success. Checkout request status fetched successfully from the checkout platform.
500	Failure. Generic failure occurred. Could be as a result of a system failure on the checkout platform.
1001	No request found.
1007	Missing country code. The checkout request posted was missing a country_code.
1013	Not JSON. The checkout request posted was not valid JSON.
1014	Missing merchant transaction ID. The request did not have a merchant_transaction_id
1015	Missing checkout request ID.The request did not have a checkout_request_id

Request Status Codes

Status Code	Status Description
129	Expired request. The checkout request expired with no payment made to it at the point of expiry. No further payments will be accepted for this request.
130	New request. The checkout request has not been paid for and has not yet expired.
133	The request with no partial payments was cancelled by the merchant without payments received on it.
177	Partially paid request. A payment made for request but the payment amount is less than the originally requested amount
178	Fully paid request. A payment made for request and the payment amount is equal or more than the originally requested amount.
179	Expired partially paid request. A payment made for request but the payment amount is less than the originally requested amount and the request has expired.
180	Payment(s) for the checkout request has been acknowledged and rejected by the merchant.
181	The request with partial payments was cancelled by the merchant without payments received on it.
183	Payment(s) for the checkout request has been acknowledged and accepted by the merchant.
184	A partial refund has been initiated for the checkout request.
185	A full reversal has been initiated for the checkout request
186	The partial refund initiated for the checkout request has been completed.
187	The full reversal initiated for the checkout request has been completed.