Transaction Endpoints (api/Transaction)
Tip: Use the page navigation section on the left to navigate quickly from one endpoint to another.
General Definitions
| Parameter | Description |
| baseurl |
Sandbox - https://test.xprizo.com/api |
| apiversion | 1.0 |
| apikey | API key For authentication |
To obtain the API key for authentication, click here to generate the API key.
Deposit With Card
Request
curl --location '{baseurl}/Transaction/CardDeposit' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"description": "<Description/narrative for the deposit/payment>",
"reference": "<Unique reference>",
"amount": <Deposit/payment amount, 2 decimal places, dot as decimal>,
"accountId": <ID of the wallet into which the amount will be deposited - NOT profile ID>,
"transferAccountId": <ID of the wallet to which the amount will be transferred after depositing, typically used for currency conversion - SEE NOTES BELOW>,
"customerData": {
"name": "<Full name of the user/customer>",
"email": "<Email address of the user/customer>",
"mobile": "<Mobile phone number of the user/customer>",
"birthDate": "<Date of birth of the user/customer. String with format 'YYYY-MM-DD'>",
"gender": "<Gender of the user/customer. 'M', 'F', or 'X'>",
"address": {
"address": "<Building number/name, unit/apt number/letter, etc>",
"street": "<Name of street, roadway, thoroughfare, etc>",
"city": "<Name of town, city, etc>",
"zipPostalCode": "<Alphanumeric depending on country>",
"stateProvinceRegion": "<Administrative sub-division, such as state, province, or territory>",
"countryCode": "<Two-letter string using uppercase characters, e.g., 'KE', 'AE'>"
},
"IpAddress": "<Customer's IP address in string format, IPv4 or IPv6>"
},
"creditCard": {
"name": "<Name on card>",
"number": "<Card number>",
"expiryMonth": <2 digit expiry month, 01-12>,
"expiryYear": <4 digit expiry year>,
"cvv": "<3 or 4 digits>"
},
"routingCode": "string",
"redirect": "string"
}'
Please note that if a parameter is indicated as REQUIRED, providing that parameter is MANDATORY. The transaction will be rejected if any mandatory parameter is missing.
DO NOT use the same card details, or the same customerData information, for multiple users/customers - it will be detected and your transactions rejected.
If you manage to process transactions with any of the mandatory fields missing, we provide no guarantee that you will be able to continue doing so, and will provide no advance notice when enforcing of such mandatory fields is implemented and deployed.
| Field | Required? | Notes |
|---|---|---|
description |
REQUIRED | Description/narrative for the deposit/payment |
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 |
amount |
REQUIRED | The deposit amount, with 2 decimal places, using dot as the decimal |
currencyCode |
Optional | Currency of the transaction. Inferred from the account wallet currency if omitted |
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 |
routingCode |
Optional | 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 |
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 |
customer |
Deprecated | Please provide the customerData object with user/customer details |
customerData.name |
REQUIRED* | The full name of the user/customer. MUST match name on card |
customerData.email |
REQUIRED* | Email address of the user/customer. DO NOT use one email address for multiple users/customers |
customerData.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 |
customerData.birthDate |
REQUIRED* | The date of birth of the user/customer. String with format YYYY-MM-DD |
customerData.gender |
REQUIRED* | The gender of the user/customer. Must be M, F, or X |
customerData.identityNumber |
Optional | National identity number of the user/customer |
customerData.ipAddress |
Optional | Customer's IP address in string format, IPv4 or IPv6. Auto-filled from the HTTP request if omitted. Being deprecated — use customerData.sourceInfo.ipAddress instead |
customerData.sourceInfo.ipAddress |
Optional | Customer's IP address in string format, IPv4 or IPv6. Preferred over the deprecated customerData.ipAddress |
customerData.sourceInfo.sourceUrl |
Optional | URL of the page from which the transaction was initiated |
customerData.browserInfo |
Optional | Browser details including userAgent, screenWidth, screenHeight, colorDepth, timeZone, and javaEnabled. May be required by specific processors for 3DS authentication |
customerData.deviceInfo |
Optional | Device details including deviceModel, osType, and osVersion. May be required by specific processors |
customerData.address.address |
REQUIRED* | Building number/name, unit/apt number/letter, etc, of the user/customer's postal address |
customerData.address.street |
REQUIRED* | Name of street, roadway, thoroughfare, etc, of the user/customer's postal address |
customerData.address.city |
REQUIRED* | Name of town, city, etc, of the user/customer's postal address |
customerData.address.zipPostalCode |
REQUIRED* | Zip/post code of the user/customer's postal address. Alphanumeric depending on country |
customerData.address.stateProvinceRegion |
Optional | Administrative sub-division, such as state, province, or territory, of the user/customer's postal address. May be required by specific processors |
customerData.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) |
creditCard.name |
REQUIRED | Name on card |
creditCard.number |
REQUIRED | Card number |
creditCard.expiryMonth |
REQUIRED | 2-digit expiry month, 01–12 |
creditCard.expiryYear |
REQUIRED | 4-digit expiry year |
creditCard.cvv |
REQUIRED | 3 or 4 digit card security code |
* Enforced per processor — which fields are mandatory depends on the acquirer resolved from the routing code.
Response (200)
{
"key": <a unique identifier for the transaction>,
"statusCode": <The number equivalent of the Status>,
"status": <Active/Rejected/Pending/Redirect>,
"value": <billingcode/reason/url>
}
| Field | Notes |
|---|---|
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 |
description |
Internal reason or narrative associated with the transaction result |
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 |
reference |
Echo of the reference field submitted in the request |
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
-
Message
Detail of Message Invalid routing codeYour 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 existsYou 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
-
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Test Configuration For Routing Options
| Routing Option | Routing Code Prefix | Configuration |
| Option A | MAN |
Amount
|
Refund Card Deposit
Request
curl --location '{baseurl}/Transaction/AddRefundCardDeposit' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"reference": "<Unique reference for this refund>",
"description": "<Reason or narrative for the refund>",
"amount": <Refund amount, 2 decimal places, dot as decimal>,
"accountId": <ID of the merchant wallet from which the refund will be issued>,
"linkedTransaction": {
"linkedTxKey": "<Key of the original CardDeposit transaction to be refunded>"
}
}'
| Field | Required? | Notes |
|---|---|---|
reference |
REQUIRED | A unique, alphanumeric string to identify this refund transaction within your own system |
description |
REQUIRED | Reason or narrative for the refund |
amount |
REQUIRED | The refund amount, with 2 decimal places, using dot as the decimal |
accountId |
REQUIRED | ID of the merchant wallet from which the refund will be issued. Do NOT use profile ID here |
linkedTransaction.linkedTxKey |
REQUIRED | The key value returned in the response of the original CardDeposit transaction that is being refunded |
Response (200)
| Field | Notes |
|---|---|
key |
A unique identifier for the refund transaction |
statusCode |
The number equivalent of the Status |
status |
Active – The refund was completed successfully; Pending – The refund needs further action; Rejected – The refund was rejected |
description |
Internal reason or narrative associated with the refund result |
value |
Active – the value will show the description; Pending – the value will show the description; Rejected – the value will show the reason |
|
|
Echo of the reference field submitted in the request |
{
"key": "<unique identifier for the refund transaction>",
"statusCode": <numeric status>,
"status": "<Active/Pending/Rejected>",
"description": "<reason or narrative>",
"value": "<description/reason>",
"reference": "<echo of the submitted reference>"
}
Errors
| Code | Description |
|---|---|
| 400 (Bad Request) | The refund could not be completed. The reason is returned — check the error, contact Xprizo, or fix the problem and try again |
| 401 (Unauthorized) | Invalid or expired token |
| 403 (Forbidden) | You are not the merchant who owns the routing code of the original transaction, your account is not marked as a merchant, or your KYC verification is not complete |
| 500 (Internal Server Error) | A critical unexpected system error has occurred. Contact Xprizo and report the error |
Deposit With Xprizo Wallet
Request
curl --location '{baseurl}/Transaction/RequestPayment' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"fromAccountId": <users_account_id>,
"toAccountId": <your_account_id>,
"description": <purpose of deposit>,
"amount": <requested amount>,
"reference":<unique reference>
}'
| 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 |
Response (200)
{
"key":<a unique identifier for the transaction>,
"approveById": <id of the person to approve the transaction>,
"canCancel": <can be cancelled or not>,
"ttl": <time left in seconds>,
"expiryDate": <date/time when the transaction expires>,
"error": ""
}
| Parameter | Description |
| key | a unique identifier for the transaction |
|
approveById
|
<id of the person to approve the transaction> |
|
canCancel
|
<can be cancelled or not> |
|
expiryDate
|
<date/time when the transaction expires> |
| ttl |
<time left in seconds> |
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Deposit With MPESA
Request
curl --location '{baseurl}/Transaction/MPesaDeposit' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"mobileNumber": <mpesa_mobile_number>,
"accountId": <your_account_id>,
"description": <purpose of deposit>,
"amount": <requested amount>,
"reference":<unique reference>
}'
| 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 |
| description |
(Optional) Text that can be used to describe the reason for the transaction. In Test Mode. use:-
|
| amount | The amount of the transaction |
| reference | A unique reference is created so that you can identify and link this transaction to your system |
Response (200)
{
"key": <a unique identifier for the transaction>,
"statusCode": <The number equivalent of the Status>,
"status": <Active/Rejected/Pending>,
"value": <transaction description>
}
| Parameter | Description |
| key | a unique identifier for the transaction |
| statusCode | The number equivalent of the Status |
| status |
|
| value |
|
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Withdrawal With MPESA
Request
curl --location '{baseurl}/Transaction/MPesaWidthdrawal' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"mobileNumber": <mpesa_mobile_number>,
"accountId": <your_account_id>,
"description": <purpose of deposit>,
"amount": <requested amount>,
"reference":<unique reference>
}'
| Parameter | Description |
| mobileNumber | Mpesa Mobile number to be used for transactions. Who will receive the funds. Sample +254706****73 |
| accountId | This is the ID of your wallet - You can check your account ID here |
| description |
(Optional) Text that can be used to describe the reason for the transaction. In Test Mode. use:-
|
| amount | The amount of the transaction |
| reference | A unique reference is created so that you can identify and link this transaction to your system |
Response (200)
{
"key": <a unique identifier for the transaction>,
"statusCode": <The number equivalent of the Status>,
"status": <Active/Rejected/Pending>,
"value": <transaction description>
}
| Parameter | Description |
| key | a unique identifier for the transaction |
| statusCode | The number equivalent of the Status |
| status |
|
| value |
|
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Deposit With UPI
Request
curl --location '{baseurl}/Transaction/UpiDeposit?useApprovalProcess=false' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data-raw '{
"description": <description of the transaction>,
"reference": <unique ID or reference supplied from your end>,
"amount": <amount to be deposited>,
"currencyCode": <currency of the transaction, must be INR>,
"type": <transaction type, must be 1>,
"accountId": <account ID for the account into which funds will be deposited>,
"customer": <alternative end user name>,
"customerData": {
"name": <the name of the end user>,
"email": <end user's email address>,
"address": {
"address": <deprecated, use address fields below>,
"street": <address street>,
"city": <address city>,
"stateProvinceRegion": <address state, province, or region>,
"zipPostalCode": <address postcode>,
"countryCode": <country code, must be IN>
}
},
"redirect": <URL to which your end user will be directed after approving the transaction>
}'
| Parameter | Description |
| description |
(Optional) Description of the transaction. |
| reference |
(Required) A unique ID or reference supplied from your end, which you can use to identify and link this transaction to your system. |
| amount | (Required) The amount of the transaction. |
| currencyCode | (Required) Currency code for the transaction currency, must be "INR". |
| type | (Required) Transaction type, must be 1. |
| accountId |
(Required) Account ID for the account into which funds will be deposited. See here how to check for your account ID. |
| customer | (Optional, see notes below) The name of the end user (alternative). |
| customerData.name | (Optional, see notes below) The name of the end user. |
| customerData.email | (Optional) End user's email address. |
| customerData.address.address | Deprecated, use address fields below. |
| customerData.address.street | (Optional) Address street. |
| customerData.address.city | (Optional) Address city. |
| customerData.address.stateProvinceRegion | (Optional) Address state, province, or region. |
| customerData.address.zipPostalCode | (Optional) Address postcode. |
| customerData.address.countryCode | (Required) Country code, must be "IN". |
| redirect | (Required) URL to which your end user will be directed after approving the transaction. |
Important Notes
- If customerData.name is present, it will be used as the end user's name.
- If customer is present, and customerData.name is not present, customer will be used as the end user's name.
- If customerData.name and customer are both not present, details from your Xprizo profile will be used:
- If your profile is of 'Individual' type, first and last name from your profile will be used.
- If your profile is of 'Legal Entity' type, trading name from your profile will be used if present, otherwise registered name from your profile will be used.
- The following query parameters will be added to the specified redirect URL when the user is redirected on completion of the transaction:
- key: System unique ID for the transaction.
- status: Transaction status.
- reference: The unique ID or reference supplied from your end.
Response (200)
{
"key": <System unique ID for the transaction>,
"statusCode": <Numeric code for transaction status>,
"status": <Transaction status>,
"description": <Currently empty/unused>,
"value": <URL to which you need to redirect your end user to approve the transaction>,
"reference": <Unique ID or reference supplied from your end>
}
| 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. |
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Send Payment (Xprizo Wallet)
Request
curl --location '{baseurl}/Transaction/SendPayment?action=<action>&pin=<pin>' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}' \
--data '{
"fromAccountId":<your_account_id>,
"toAccountId": <users_account_id>,
"reference": <unique reference>,
"amount": <requested amount>,
"description": <purpose of payment>
}'
| 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 |
Response (200) If action = 0 or Not provided in request
{
"key":<a unique identifier for the transaction>,
"approveById": <id of the person to approve the transaction>,
"canCancel": <can be cancelled or not>,
"ttl": <time left in seconds>,
"expiryDate": <date/time when the transaction expires>,
"error": ""
}
| Parameter | Description |
| key | a unique identifier for the transaction |
|
approveById
|
<id of the person to approve the transaction> |
|
canCancel
|
<can be cancelled or not> |
|
expiryDate
|
<date/time when the transaction expires> |
| ttl |
<time left in seconds> |
Response (200) If action = 1 or 2
{
"id":<a unique identifier for the transaction>,
"description": "<The type of transaction processed (Payment)>"
}
Errors
- 400 (Bad Request) The transaction could not be completed. The reason is returned Check the error, contact Xprizo, or fix the problem and try again.
- 401 (Unauthorized) Invalid or expired token.
- 403 (Forbidden) You do not have the right to create or approve this transaction.
- 500 (Internal Server Error) A critical unexpected system error has occurred. Contact Xprizo and report the error.
Approve Payment (Xprizo Wallet)
Request
curl --location '{baseurl}/Transaction/ApprovalAccept?key=<key>&pin=<pin>&once=<true/false>' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}'
| 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. |
Response (200)
{
"id":<a unique identifier for the transaction>,
"description": "<The type of transaction processed (Payment)>"
}
Cancel Payment (Xprizo Wallet)
Request
curl --location '{baseurl}/Transaction/ApprovalCancel?key=<key>' \
--header 'Accept: text/plain; x-api-version=1.0' \
--header 'Content-Type: application/json; x-api-version=1.0' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}'
| Parameter | Description |
| key |
A unique ID of the transaction you wish to approve |
Response (200) Transaction is canceled successfully
Check Transaction Status
This endpoint can be used to check the status of any type of transaction for example card deposit, Mpesa withdrawal etc.
Request
curl --location '{baseurl}/Transaction/Status/{accountId}/?reference={reference}' \
--header 'x-api-version: {apiversion}' \
--header 'x-api-key: {apikey}'
| Parameter | Description |
| accountId | This is the ID of the wallet that contains the transaction. When requesting a payment use the ID of the recipient's wallet. |
| reference | The reference is the Merchants unique transaction identifier for this transaction |
Response (200)
{
"key" : <a unique identifier for the transaction>
"statusCode" : <0/3/1/-1/4/5/6>
"status" : <Active/Rejected/Pending/NotFound/Cancelled/Hold/Void >
"value" : <billingdescription/transaction description/Void reason>
}
# Pending Transaction
{
"key": "",
"statusCode": 1,
"status": "Pending",
"value": "Pass"
}
# Approved Transaction
{
"key": "3169",
"statusCode": 0,
"status": "Active",
"value": "testing.com Pass"
}
# Rejected Transaction
{
"key": "144",
"statusCode": 3,
"status": "Rejected",
"value": "Failed Test"
}
# Not Found Transaction
{
"key": "",
"statusCode": -1,
"status": "NotFound",
"value": ""
}
# Hold Transaction (Mpesa Withdrawal)
{
"key": "144",
"statusCode": 5,
"status": "Hold",
"value": "Mpesa Withdrawal +254342222222"
}
# Void Transaction (Mpesa Withdrawal)
{
"key": "144",
"statusCode": 6,
"status": "Void",
"value": "342222222 Voided: No Response Data"
}
| Parameter | Description |
| key |
This is the unique ID of the transaction.
|
| status |
The status of the transaction - It can be one of the following:
|
| value |
|