Automatically deposit funds to multiple account holders
To perform a deposit (or cash-in), where e-money will be transferred from the agent to the consumer in exchange for cash.<br>Deposit operation is used to deposit an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /deposit/\{referenceId\}
Bearer Authentication Token generated using CreateAccessToken API Call
(POST Method)URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created Deposit transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string",
"currency": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
To perform a deposit (or cash-in), where e-money will be transferred from the agent to the consumer in exchange for cash.<br>Deposit operation is used to deposit an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /deposit/\{referenceId\}
Bearer Authentication Token generated using CreateAccessToken API Call
(PUT Method)URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string",
"currency": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a deposit. X-Reference-Id that was passed in the post is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Deposit.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Bad request, e.g. an incorrectly formatted reference id was provided.
Resource not found.
{
"code": "RESOURCE_NOT_FOUND",
"message": "Requested resource was not found."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error. Note that if the retreieved transfer has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.
{
"code": "INTERNAL_PROCESSING_ERROR",
"message": "An internal error occurred while processing."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
refund operation is used to refund an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /refund/\{referenceId\}
Bearer Authentication Token generated using CreateAccessToken API Call
(POST Method)URL to the server where the callback should be sent.
Format - UUID. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": 100,
"currency": "ZMW",
"externalId": 123456,
"payerMessage": "paying",
"payeeNote": "receiving",
"referenceIdToRefund": "UUID-REQUEST-TO-PAY"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
refund operation is used to refund an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /refund/\{referenceId\}
Bearer Authentication Token generated using CreateAccessToken API Call
(PUT Method)URL to the server where the callback should be sent.
Format - UUID. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": 100,
"currency": "ZMW",
"externalId": 123456,
"payerMessage": "paying",
"payeeNote": "receiving",
"referenceIdToRefund": "UUID-REQUEST-TO-PAY"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a refund. X-Reference-Id that was passed in the post is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Refund.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK. Note that a failed transfer will be returned with this status too. The 'status' of the RefundResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Bad request, e.g. an incorrectly formatted reference id was provided.
Resource not found.
{
"code": "RESOURCE_NOT_FOUND",
"message": "Requested resource was not found."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error. Note that if the retreieved transfer has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.
{
"code": "INTERNAL_PROCESSING_ERROR",
"message": "An internal error occurred while processing."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to claim a consent by the account holder for the requested scopes.
Value: Bearer JWT
Replace JWT with a valid token received from token endpoint in Wallet Platform.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
URL to the server where the callback should be sent.
login_hint=ID:{msisdn}/MSISDN&scope={scope}&access_type={online/offline}
OK
{
"auth_req_id": "string",
"interval": 0,
"expires_in": 0
}
This operation is used to claim a consent by the account holder for the requested scopes.
Bearer Token. Replace with a valid oauth2 token received from oauth2 token endpoint in Wallet Platform.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK
{
"sub": "string",
"name": "string",
"given_name": "string",
"family_name": "string",
"middle_name": "string",
"email": "string",
"email_verified": true,
"gender": "string",
"locale": "string",
"phone_number": "string",
"phone_number_verified": true,
"address": "string",
"updated_at": 0,
"status": "string",
"birthdate": "string",
"credit_score": "string",
"active": true,
"country_of_birth": "string",
"region_of_birth": "string",
"city_of_birth": "string",
"occupation": "string",
"employer_name": "string",
"identification_type": "string",
"identification_value": "string"
}
Transfer operation is used to transfer an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /transfer/\{referenceId\} feature level 7.4 or higher
Oauth2 Access token.
URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a transfer. X-Reference-Id that was passed in the post is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Oauth2Transfer.
Bearer Authentication Token generated using CreateAccessToken API Call
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Merchant payment is a asynchronous operation and will return a response directly. The result will be stored in the database in Partner Gateway as a financial instruction. Partner Gateway will add a new scheduled task to fetch transaction status until the transaction has either failed or been successful. A callback will be initiated towards partner when the transaction status is either successful or failed.
Oauth2 Access token.
URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a transfer. X-Reference-Id that was passed in the post is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Oauth2MerchantPayment.
Bearer Authentication Token generated using CreateAccessToken API Call
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Payment is a asynchronous operation and will return a response directly. The result will be stored in the database in Partner Gateway as a financial instruction. Partner Gateway will add a new scheduled task to fetch transaction status until the transaction has either failed or been successful. A callback will be initiated towards partner when the transaction status is either successful or failed.
Oauth2 Access token.
URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created Oauth2Payment transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used for fetching the transaction status for payment
UUID of transaction to get result. Reference id used when creating the request to pay.
Bearer Authentication Token generated using CreateAccessToken API Call
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Transfer to any bank account is a asynchronous operation and will return a response directly. The result will be stored in the database in Partner Gateway as a financial instruction. Partner Gateway will add a new scheduled task to fetch transaction status until the transaction has either failed or been successful. A callback will be initiated towards partner when the transaction status is either successful or failed.
Oauth2 Access token.
URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used for fetching the transaction status for payment
UUID of transaction to get result. Reference id used when creating the Oauth2BankTransfer.
Bearer Authentication Token generated using CreateAccessToken API Call
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
This operation returns personal information of the account holder. The operation does not need any consent by the account holder.
MSISDN of the account holder. Mobile number validated according to ITU-T E.164.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK
{
"given_name": "string",
"family_name": "string",
"birthdate": "string",
"locale": "string",
"gender": "string",
"status": "string"
}
Unauthorized
{
"error": "string"
}
Error
This operation is used to claim a consent by the account holder for the requested scopes.
Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK
{
"access_token": "string",
"token_type": "string",
"expires_in": 0,
"scope": "string",
"refresh_token": "string",
"refresh_token_expired_in": 0
}
This operation is used to create an access token which can then be used to authorize and authenticate towards the other end-points of the API.
Basic authentication header containing API user ID and API key. Should be sent in as B64 encoded.
OK
{
"access_token": "string",
"token_type": "string",
"expires_in": 0
}
Unauthorized
{
"error": "string"
}
Error
Get the balance of own account.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
Ok
{
"availableBalance": "string",
"currency": "string"
}
Bad request, e.g. invalid data was sent in the request.
Internal error. The returned response contains details.
{
"code": "NOT_ALLOWED_TARGET_ENVIRONMENT",
"message": "Access to target environment is forbidden."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Operation is used to check if an account holder is registered and active in the system.
The AccountHolder number. Validated according to the AccountHolderID type. <br> MSISDN - Mobile Number validated according to ITU-T E.164. Validated with IsMSISDN<br> EMAIL - Validated to be a valid e-mail format. Validated with IsEmail
Specifies the type of the AccountHolderID. Allowed values [msisdn, email]
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
Ok. True if account holder is registered and active, false if the account holder is not active or not found found
Bad request, e.g. invalid data was sent in the request.
Internal error. The returned response contains details.
{
"code": "NOT_ALLOWED_TARGET_ENVIRONMENT",
"message": "Access to target environment is forbidden."
}
Transfer is used for transferring funds from the Merchant (Partner) account to another account holder.<br>Transfer operation is used to transfer an amount from the owner’s account to a payee account.<br> Status of the transaction can be validated by using the GET /transfer/\{referenceId\}
Bearer Authentication Token generated using CreateAccessToken API Call
URL to the server where the callback should be sent.
Format - UUID. Recource ID of the created ‘request-to-pay’ transaction. This ID is used for e.g. validating the status of the request. Universal Unique ID for the transaction generated using UUID version 4.
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"amount": "string",
"currency": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string"
}
Accepted
Bad request, e.g. invalid data was sent in the request.
Conflict, duplicated reference id
{
"code": "RESOURCE_ALREADY_EXIST",
"message": "Duplicated reference id. Creation of resource failed."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error.
{
"code": "INVALID_CURRENCY",
"message": "Currency not supported."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a transfer. X-Reference-Id that was passed in the post is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Transfer.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
OK. Note that a failed transfer will be returned with this status too. The 'status' of the TransferResult can be used to determine the outcome of the request. The 'reason' field can be used to retrieve a cause in case of failure.
{
"amount": 100,
"currency": "UGX",
"financialTransactionId": 363440463,
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "PAYER_LIMIT_REACHED",
"message": "The payer's limit has been breached."
}
}
{
"amount": 100,
"currency": "UGX",
"externalId": 83453,
"payee": {
"partyIdType": "MSISDN",
"partyId": 4609274685.0
},
"status": "FAILED",
"reason": {
"code": "NOT_ENOUGH_FUNDS",
"message": "The payer does not have enough funds."
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payee": {
"partyIdType": "MSISDN",
"partyId": "string"
},
"payerMessage": "string",
"payeeNote": "string",
"status": "PENDING",
"reason": {
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
}
Bad request, e.g. an incorrectly formatted reference id was provided.
Resource not found.
{
"code": "RESOURCE_NOT_FOUND",
"message": "Requested resource was not found."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Internal Error. Note that if the retreieved transfer has failed, it will not cause this status to be returned. This status is only returned if the GET request itself fails.
{
"code": "INTERNAL_PROCESSING_ERROR",
"message": "An internal error occurred while processing."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
Get the balance of own account. Currency parameter passed in GET
Should be in ISO4217 Currency
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
Ok
{
"availableBalance": "string",
"currency": "string"
}
Bad request, e.g. invalid data was sent in the request.
Internal error. The returned response contains details.
{
"code": "NOT_ALLOWED_TARGET_ENVIRONMENT",
"message": "Access to target environment is forbidden."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to send delivery notifications for successfully completed transfers. The X-Reference-Id that was passed in the POST is used as reference to the request.
UUID of transaction to get result. Reference id used when creating the Transfer.
An ISO 639-1 or ISO 639-3 language code. The language is used to select the best matching notification template when sending the delivery notification to the end-user. A default value is used if not specified.
Bearer Authentication Token generated using CreateAccessToken API Call
The identifier of the Wallet Platform system where the transaction shall be processed. This parameter is used to route the request to the Wallet Platform system that will initiate the transaction.
{
"notificationMessage": "Type Your Message Here"
}
OK. Notification successfully enqueued.
Bad request. Invalid data was sent in the request.
Resource not found. The reference ID does not exist, or the calling user is not the owner of the financial transaction.
Conflict. The transaction is not successfully completed.
Gone. The delivery notification opportunity has expired.
Too many requests. Too many attempts for the same ID has been made recently. This will only occur if a successful attempt has previously been performed.
Internal server error. An unexpected error occurred.