Parameter	Description
accountId	(REQUIRED) This is the ID of the wallet into which the amount will be deposited. Do NOT use profile ID here. The Wallet ID can be seen in the 'Wallets' screen of your Xprizo console/dashboard, column 'Account'.
transferAccountId	(Optional) This is the ID of the wallet to which the amount will be transferred after depositing. *\\Note: This is required when you want to deposit money in a wallet of currency that is not supported by the acquirer. In this case we will do an internal transfer and at the time of the transfer currency conversion charges may apply.*
reference	(REQUIRED) A unique, alphanumeric string used to identify and track this specific transaction within your own system. If you're a merchant, you can use your own order ID here, as long as it is unique.
customer	(Deprecated) Please provide "customerData" object with user/customer details.
name	(REQUIRED) The full name of the user/customer. MUST match name on card.
email	(REQUIRED) Email address of the user/customer. DO NOT use one email address for multiple users/customers.
mobile	(REQUIRED) Mobile phone number of the user/customer. Must be provided in E.164 format, which consists of a leading + symbol followed by the country code and the full subscriber number (including area code) without any spaces, dashes, or leading zeros (e.g., "+25412345678"). DO NOT use one mobile phone number for multiple users/customers.
birthDate	(REQUIRED) The date of birth of the user/customer. String with format "YYYY-MM-DD".
gender	(REQUIRED) The gender of the user/customer. Must be 'M', 'F', or 'X'.
address	(REQUIRED) Building number/name, unit/apt number/letter, etc, of the user/customer's postal address.
street	(REQUIRED) Name of street, roadway, thoroughfare, etc, of the user/customer's postal address.
city	(REQUIRED) Name of town, city, etc, of the user/customer's postal address.
zipPostalCode	(REQUIRED) Zip/post code of the user/customer's postal address. Alphanumeric depending on country.
stateProvinceRegion	(Optional) Administrative sub-division, such as state, province, or territory, of the user/customer's postal address.
countryCode	(REQUIRED) Country of the user/customer's postal address. The country code must be provided as a two-letter string following the ISO 3166-1 alpha-2 standard, using uppercase characters (e.g., "KE", "AE").
ipAddress	(REQUIRED) Customer's IP address in string format, IPv4 or IPv6.
amount	(REQUIRED) The deposit amount, with 2 decimal places, using dot as the decimal.
description	(REQUIRED) Description/narrative for the deposit/payment.
routingCode	Use one of the routing codes that have been set on your account (routing codes are used for different currencies and limits). These will be configured by the Xprizo Team and you can find them [here](https://books.xprizo.com/books/user-manual/page/card-routing-codes).
redirect	(REQUIRED) The card is processed using 3DS, so you will need to open a confirmation screen (the redirect URL for the confirmation screen is returned in the response to this request). This redirect is the URL that the user will be returned to after the confirmation screen has been closed.

Parameter	Description
baseurl	Sandbox - [https://test.xprizo.com/api](https://test.xprizo.com/api) Live- [https://wallet.xprizo.com/api](https://wallet.xprizo.com/api)
apiversion	1.0
apikey	API key For authentication

Parameter	Description
key	a unique identifier for the transaction
statusCode	The number equivalent of the Status
status	- Active – The transaction was completed successfully - Pending – The transaction was unable to be completed and needs further action - Rejected - The transaction was rejected - Redirect – (3DS) the user needs to be redirected to another URL to complete the transaction
value	- Active – the value will show the description - Pending - the value will show the description - Rejected - the value will show the reason - Redirect - the value will show the URL to redirect to

Message	Detail of Message
Invalid routing code	Your account does not have the routing code configured. Please contact the Xprizo team to have this set up.
Invalid routing code (No Mid Set)	Your account does not have the MID configured. Please reach out to the Xprizo team to have this configured.
A transaction with this reference already exists	You need to generate a new reference and try again
A pending transaction with this reference already exists (Ref:652-1706532591287))	The transaction is already available for this reference number with status pending, please check the status of this or try again with a new reference number

Routing Option	Routing Code Prefix	Configuration
Option A	MAN	Amount - $1.00 or $2.00 - Active( 2DS Success) - $3.00 or $4.00 - Rejected - $5.00 or $6.00 - Rdirect (3DS Redirect URL) - $7.00 or greater - Rejected Case In 3DS

Parameter	Description
fromAccountId	This is the ID of the payee's wallet - the user who is paying out the funds
toAccountId	This is the ID of recipient's wallet - the user who will receive the funds
description	(Optional) Text that can be used to describe the reason for the transaction
amount	The amount of the transaction
reference	A unique reference is created so that you can identify and link this transaction to your system

Parameter	Description
mobileNumber	Mpesa Mobile number to be used for transaction
accountId	This is the ID of recipient's wallet - the user who will receive the funds. You can check your account id [here](https://books.xprizo.com/link/13#bkmrk-know-your-account-id)
description	(Optional) Text that can be used to describe the reason for the transaction. In Test Mode. use:- - Pass, Success - the transaction will be created as approved. - Reject, Fail, Cancel - the transaction will be created and then rejected.
amount	The amount of the transaction
reference	A unique reference is created so that you can identify and link this transaction to your system

Parameter	Description
key	System unique ID for the transaction.
statusCode	A numeric code for the status of the transaction.
status	The status of the transaction.
value	The URL to which you need to redirect your end user to approve the transaction.
description	Currently empty/unused.
reference	Unique ID or reference supplied from your end, which you can use to identify and link this transaction to your system.

Parameter	Description
action	0 or default (Transaction will go in approval mode and payee needs to approve the transaction) 1 (Transaction will be completed with any approval) 2 (Transaction will be on hold until Xprizo will receive HTTP code 200 on payment webhook)
pin	Required if the user implemented "Approval Security"
fromAccountId	This is the ID of the payee's wallet - the user who is paying out the funds
toAccountId	This is the ID of the recipient's wallet - the user who will receive the funds
description	(Optional) Text that can be used to describe the reason for the transaction
amount	The amount of the transaction
reference	A unique reference is created so that you can identify and link this transaction to your system

Parameter	Description
key	A unique ID of the transaction you wish to approve
pin	Required if the user implemented "Approval Security"
once	Set this to true, if you want to automatically cancel this transaction if an error occurs when processing the transaction.

Parameter	Description
key	This is the unique ID of the transaction. - When Active or Hold or Void this will contain the transaction ID - When Rejected or Cancelled, it will be the ID given in the log file for the entry. - When pending or NotFound, it will be blank.
status	The status of the transaction - It can be one of the following: - Active - The transaction is a valid active transaction - Pending - The transaction is awaiting approval (or rejection). - NotFound - A transaction on this wallet, with this reference does not exist. - Rejected - the transaction has been rejected by the acquirer. - Cancelled - If Xprizo cancels the transaction due to technical error or invalid calls. - Hold - This is applicable for Mpesa withdrawal
value	- When Active this will contain the billing description For card deposit & transaction description for other transactions. - When Hold this will contain the withdrawal description - When Void this will contain the void reason - When Rejected or Cancelled, it will contain the reason. - When pending or NotFound, it will be blank