APN

AVAILABLE IN

South Africa

Download

Download Postman collection Download Swagger

Available endpoints

GET v1/networks/apns

Description

retrieve a list of all active APNs

Header parameters

Content-Type application/json

Query parameters

transactionId string required
Transaction ID
sourceIdentifier string required
Source system
thirdPartyId string required
Partner
200OK
transactionId string
statusCode string
supportMessage string
data
apnList
apnId string
apnName string
thirdPartyId string
customerId string
debtorId string
_links
self
href string
type string
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "data": {
        "apnList": {
            "apnId": "string",
            "apnName": "string",
            "thirdPartyId": "string",
            "customerId": "string",
            "debtorId": "string"
        }
    },
    "_links": {
        "self": {
            "href": "string",
            "type": "string"
        }
    }
}
401Unauthorized
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
GET v1/networks/apn-bundles

Description

Retrieve APN by ID

Header parameters

Content-Type application/json

Query parameters

transactionId string required
Transaction ID
sourceIdentifier string required
Source system
thirdPartyId string required
Partner
200OK
transactionId string
statusCode string
supportMessage string
statusMessage string
data
productList
productName string
denomination string
productCode string
productDescription string
productType string
_links
self
href string
type string
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "data": {
        "productList": {
            "productName": "string",
            "denomination": "string",
            "productCode": "string",
            "productDescription": "string",
            "productType": "string"
        }
    },
    "_links": {
        "self": {
            "href": "string",
            "type": "string"
        }
    }
}
404Not Found
400Bad Request
401Unauthorized
403Forbidden
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
POST v1/networks/apn-bundles

Description

This API is used to add product .

Header parameters

Content-Type application/json

FormData parameters

transactionId string
Unique identifier of the transaction.Fixed length '15' characters.
sourceIdentifier string
Identifies the source system which is initiating the request.
apnId string
APN Id to which product is being added.
thirdPartyId string
Unique Identifier of the third party system.
productCode string
Code of the product that is being added.
productType string
Ad hoc or Recurring type
action string
Action Code e.g, 'ADD'
102Processing
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference number of the transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
400Bad Request
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string"
}
401Unauthorized
403Forbidden
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string"
}
200OK
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference of the transaction.
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
500Internal Server Error
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference of the transaction.
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
DELETE v1/networks/apn-bundles

Description

This API is used to remove product.

Header parameters

Content-Type application/json

Query parameters

transactionId string required
Unique identifier of the transaction.Fixed length '15' characters
sourceIdentifier string required
Identifies the source system which is initiating the request.
apnId string required
APN Id on which the given bundle is removed .
thirdPartyId string required
Unique Identifier of the third party system.
productCode string required
Code of the product that is being removed .
productType string required
Type of the product e.g, 'Adhoc' or 'Recurring'
action string required
Action Code i.e, 'REMOVE'
102Processing
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference number of the transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
400Bad Request
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string"
}
401Unauthorized
403Forbidden
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string"
}
200OK
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference of the transaction.
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
500Internal Server Error
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference of the transaction.
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
POST v1/networks/apns/associate-apn

Description

Associate MSISDN to APN

Header parameters

Content-Type application/json

FormData parameters

transactionId string required
Unique identifier of the transaction.Fixed length '15' characters.
sourceIdentifier string required
Identifies the source system which is initiating the request.
callBackUrl string
Partner URL to post associate response
msisdn string required
Subscriber mobile number.
thirdPartyId string required
Unique Identifier of the third party system.
apnList array
APN List to which given MSISDN is associated.
102Processing
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference number of the transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
POST v1/networks/apns/dissociate-apn

Description

Dissociate MSISDN to APN

Header parameters

Content-Type application/json

FormData parameters

transactionId string required
Unique identifier of the transaction.Fixed length '15' characters.
sourceIdentifier string required
Identifies the source system which is initiating the request.
callBackUrl string
Partner URL to post associate response
msisdn string required
Subscriber mobile number.
thirdPartyId string required
Unique Identifier of the third party system.
apnList array
APN List to which given MSISDN is associated.
102Processing
transactionId string
Unique identifier of the transaction.Fixed length '15' characters
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
referenceNumber string
Reference number of the transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "referenceNumber": "string"
}
200OK
400Bad Request
401Unauthorized
403Forbidden
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
POST v1/networks/apns/validate-party

Description

Third party verificatiom

Header parameters

Content-Type application/json

Query parameters

transactionId string required
Transaction ID
sourceIdentifier string required
Source system
thirdPartyId string required
Partner
200OK
transactionId string
statusCode string
supportMessage string
statusMessage string
data
apnDetails
apnId string
apnName string
thirdPartyId string
customerId string
debtorId string
_links
self
href string
type string
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "data": {
        "apnDetails": {
            "apnId": "string",
            "apnName": "string",
            "thirdPartyId": "string",
            "customerId": "string",
            "debtorId": "string"
        }
    },
    "_links": {
        "self": {
            "href": "string",
            "type": "string"
        }
    }
}
404Not Found
400Bad Request
401Unauthorized
403Forbidden
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
POST v1/networks/apns/verify-apn

Description

remove msisdn from a given APN

Header parameters

Content-Type application/json

Query parameters

transactionId string required
Transaction ID
sourceIdentifier string required
Source system
apnId string required
apn id
thirdPartyId string required
Partner
200OK
transactionId string
statusCode string
supportMessage string
statusMessage string
data
apnDetails
apnId string
apnName string
thirdPartyId string
customerId string
debtorId string
_links
self
href string
type string
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string",
    "data": {
        "apnDetails": {
            "apnId": "string",
            "apnName": "string",
            "thirdPartyId": "string",
            "customerId": "string",
            "debtorId": "string"
        }
    },
    "_links": {
        "self": {
            "href": "string",
            "type": "string"
        }
    }
}
400Bad Request
401Unauthorized
403Forbidden
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
PUT v1/networks/sims

Description

Sim swap

Header parameters

Content-Type application/json

FormData parameters

transactionId string
Unique identifier of the transaction.
sourceIdentifier string
Identifies the source system which is initiating the request.
msisdn string
Subscriber mobile number.Atleast oldSimNumber or msisdn need to be provided in the request.
oldSimNumber string
Subscriber Identity Module number of the subscriber.Atleast oldSimNumber or msisdn need to be provided in the request.
newSimNumber string
Subscriber Identity Module number of the subscriber.
thirdpartyId string
Unique Identifier of the third party system.
requestedProcessingStartDate string
Processing start date of the given request as wished by the third party customer. E.g :- 2019-04-21T17:32:28Z
200OK
transactionId string
Unique identifier for every request to SOA. Mapped from input request
statusCode string
Status of the transaction • 0- Success • Any value other than 0- Failure
supportMessage string
Support message for the transaction.
statusMessage string
Indicates status of transaction
{
    "transactionId": "string",
    "statusCode": "string",
    "supportMessage": "string",
    "statusMessage": "string"
}
400Bad Request
401Unauthorized
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
403Forbidden
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
404Not Found
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
405Method Not Allowed
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}
500Internal Server Error
timestamp string
Error response code
status string
Text explaining the reason for the error
error string
message string
More error details and corrective measures
path string
{
    "timestamp": "string",
    "status": "string",
    "error": "string",
    "message": "string",
    "path": "string"
}