MTN Customer Loans v2

AVAILABLE IN

Ghana Nigeria

Download

Download Postman collection Download Swagger

Available endpoints

POST v2/customers/{customerId}/loans/advance

Description

Get a loan advance for an MTN customer.

Header parameters

Content-Type application/json

FormData parameters

bundleName string
Name of eligible loan bundle value
bundleValue string
Name of eligible loan bundle value
amount number
Price of loan bundle
bundleType string
200OK
statusCode string
statusMessage string
Status Message
transactionId string
API generated Id to include for tracing requests
loanDetails
bundleName string
Name of eligible loan bundle value
bundleValue string
Name of eligible loan bundle value
amount number
Price of loan bundle
bundleType string
_links
self string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "loanDetails": [],
    "_links": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
GET v2/customers/{customerId}/loans/advance/status

Description

Get a loan advance status for an MTN customer.

Header parameters

transactionId string
The transaction Id used in making the loan advance request
Content-Type application/json
200OK
statusCode string
Status Code
statusMessage string
Status Message
transactionId string
Client or API generated Id to include for tracing requests
data
status string
timestamp string
Execution timestamp. example 1519980450143
_links
self string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "data": [],
    "_links": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
GET v2/customers/{customerId}/loans/eligibleBundle

Description

Retrieves loan eligibility status of an MTN customer.

Header parameters

Content-Type application/json

Query parameters

type string
Specify the type of eligibility to check for. Returns all if none is specified.
200OK
statusCode string
Status Code
statusMessage string
Status Message
transactionId string
API generated Id to include for tracing requests
eligibilityStatus string
eligible
eligibilityType string
bundles
bundleName string
Name of eligible loan bundle
bundleValue string
Name of eligible loan bundle value
validity string
amount number
Price of loan bundle
_links
self string
{
    "statusCode": [],
    "statusMessage": [],
    "transactionId": [],
    "eligibilityStatus": [],
    "eligible": [],
    "_links": []
}
401Unauthorized
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
403Forbidden
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}
404Not Found
statusCode string
This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'
statusMessage string
More details and corrective actions related to the error which can be shown to a client
supportMessage string
Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)
transactionId string
This is the same transactionId that is sent in the request
timestamp string
Timestamp that the error occurred
path string
The path that caused the error
{
    "statusCode": [],
    "statusMessage": [],
    "supportMessage": [],
    "transactionId": [],
    "timestamp": [],
    "path": []
}