Partner Gateway API document
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 the account.
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP 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 party number. Validated according to the party ID type (case Sensitive). <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<br> party_code - UUID of the party. Validated with IsUuid
Specifies the type of the party ID. Allowed values [msisdn, email, party_code]. <br> accountHolderId should explicitly be in small letters.
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP 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
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."
}
This operation is used to request a payment from a consumer (Payer). The payer will be asked to authorize the payment. The transaction will be executed once the payer has authorized the payment. The requesttopay will be in status PENDING until the transaction is authorized or declined by the payer or it is timed out by the system.
Status of the transaction can be validated by using the GET /requesttopay/\<resourceId\>
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received 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 example, validating the status of the request. ‘Universal Unique ID’ for the transaction generated using UUID version 4.
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.
{
"amount": "string",
"currency": "string",
"externalId": "string",
"payer": {
"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": "INTERNAL_PROCESSING_ERROR",
"message": "An internal error occurred while processing."
}
{
"code": "PAYEE_NOT_FOUND",
"message": "string"
}
This operation is used to get the status of a request to pay. 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 request to pay.
Authorization header used for Basic authentication and oauth. Format of the header parameter follows the standard for Basic and Bearer. Oauth uses Bearer authentication type where the credential is the received access token.
The identifier of the EWP system where the transaction shall be processed. This parameter is used to route the request to the EWP system that will initiate the transaction.
OK. Note that a failed request to pay will be returned with this status too. The 'status' of the RequestToPayResult 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": 23503452,
"externalId": 947354,
"payer": {
"partyIdType": "MSISDN",
"partyId": 4656473839
},
"status": "SUCCESSFUL"
}
{
"amount": 100,
"currency": "UGX",
"externalId": 947354,
"payer": {
"partyIdType": "MSISDN",
"partyId": 4656473839
},
"status": "FAILED",
"reason": {
"code": "PAYER_NOT_FOUND",
"message": "Payee does not exist"
}
}
{
"amount": "string",
"currency": "string",
"financialTransactionId": "string",
"externalId": "string",
"payer": {
"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 retrieved request to pay 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"
}