Balance Management V1

AVAILABLE IN

Côte d'Ivoire Zambia

Download

Download Postman collection Download Swagger

Available endpoints

POST v1/accounts/{recipientPhoneNumber}/topUp

Description

Manages Customer accountBalance information by specifying the 'recipientPhoneNumber'.

Header parameters

transactionId string
Client generated Id to include for tracing requests, so that the API can easily trace the HTTP request all the way from a client to MTNs backend processes (via our proxies). Each time a request is made to an MTN API the client should include a unique request reference in the HTTP Header. The value must be between 5 and 20 characters, and consist of ASCII letters, digits, or the characters +, /, =, and -. Invalid or blank IDs will be ignored and replaced with generated ones. MTN may use this to detect duplicate transactions from the client, but this functionality is not always guaranteed, so clients must make their own efforts to prevent duplicate transactions. MTN will also log the transactionId in order to assist with debugging and to correlate transactions processed by the API to requests from the client.
Content-Type application/json

Auth parameters

apikey X-API-Key

FormData parameters

currency string
Currency of the country where topup is performed
clientReference string
Comment that the client want to assign to this transaction.
balanceType string required
Specifying the bucket type on which the topUp should be performed.
senderAccountId string required
the AccountId on ERS of the sender. This is needed ot identify the Reseller's account on ERS
amount object
The amount details for a wallet. Decimals and negatives not allowed
Properties:
    type:
        type: string
        description: This is the type of the wallet value.
        options: CURRENCY, DATA, MINUTES, SMS
    value:
        type: string
        description: This is the value of a balance wallet.
        example: 45.25
    unit:
        type: string
        description: This is the unit of the wallet value.
        options: ZAR, NGN, GB, MB, MINUTES, SMS, FCFA
        example: NGN
200OK
statusCode string
HTTP error code extension
Data
requestedTopUpAmount
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderInformation
senderAccountNumber string
Account number of the Reseller on ERS
senderAccountDescription string
Sender Account Description
senderCreditLimit
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderUpdatedBalance
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderStatus string
The account status of the sender
senderPhoneNumber string
PhoneNumber of the sender / Reseller for whom the Topup is intended. The format must be E.123
recipientInformation
recipientAccountId string
The ERS AccountID of the Recipient
recipientPhoneNumber string
the recipient's Phone Number
recipientUpdatedBalance
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
actualTopUpAmount
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "Data": [],
    "_links": []
}
204No Content
statusCode string
HTTP error code extension
Data
requestedTopUpAmount
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderInformation
senderAccountNumber string
Account number of the Reseller on ERS
senderAccountDescription string
Sender Account Description
senderCreditLimit
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderUpdatedBalance
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
senderStatus string
The account status of the sender
senderPhoneNumber string
PhoneNumber of the sender / Reseller for whom the Topup is intended. The format must be E.123
recipientInformation
recipientAccountId string
The ERS AccountID of the Recipient
recipientPhoneNumber string
the recipient's Phone Number
recipientUpdatedBalance
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
actualTopUpAmount
type string
This is the type of the wallet value.
value string
This is the value of a balance wallet.
unit string
This is the unit of the wallet value.
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "Data": [],
    "_links": []
}
400Bad Request
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
401Unauthorized
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
403Forbidden
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
404Not Found
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
405Method Not Allowed
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
406Not Acceptable
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
415Unsupported Media Type
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}
500Internal Server Error
statusCode string
HTTP error code extension
statusMessage string
More details and corrective actions related to the error which can be shown to a client.
supportMessage string
Support Message
transactionId string
Message ID
_links
self
href string
Hyperlink to access the problem.
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "_links": []
}