API Reference International Services

International Services

List International Countries
GET

This Lists all the countries supported for international bill payments.

Service Information

baseUrl/intl_services/get_countries?key={{publicKey}}&loginId={{loginId}}
GET
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
data String M Contains the dataset of countries supported 
{
    'statusCode': '00',

    'statusDescription': 'successful',

    'data': {

    'USD': {

    'country': 'United State Of America',

    'currency': 'USD',

    'currency_code': '840'

    },
    'GBP': {

    'country': 'United Kingdom',

    'currency': 'GBP',

    'currency_code': '826'

    },
    'CAD': {

    'country': 'Canada',

    'currency': 'CAD',

    'currency_code': '124'

} } }
List International Services For Country
GET

This Lists all the services supported for international bill payments by a country.

Service Information

baseUrl/intl_services/get_services?key={{publicKey}}&loginId={{loginId}}& currency={{usd}}
GET
application/json
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
data String M Contains the dataset of services supported by a particular country 
{
    'statusCode': '00',

    'statusDescription': 'successful',

    'data': [

    {
    'service_code': 'INT1',

    'service_name': 'AT&T-Mobile Top Up',

    'currency': 'USD',

    'provider_min_amount': '15',

    'provider_max_amount': '100',

    'hasPackages': 0,

    'packages': []

    }, {
    'service_code': 'INT2',

    'service_name': 'T-Mobile-Mobile Top Up',

    'currency': 'USD',

    'provider_min_amount': '10',

    'provider_max_amount': '100',

    'hasPackages': 0,

    'packages': []

    }, {
    'service_code': 'INT3',

    'service_name': 'Verizon Wireless-Mobile Top Up',

    'currency': 'USD',

    'provider_min_amount': '15',

    'provider_max_amount': '100',

    'hasPackages': 0,

    'packages': [] } ] 
}
Get Exchange Rate
GET

Get exchange rate for a particular currency.

Service Information

baseUrl/intl_services/exchange_rate?key={{publicKey}}&loginId={{loginId}}& currency=usd&amount=2
GET
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
key String M Merchants (public) key
currency String M The currency you are converting to. it must be part of the countries from the get countries API call.
amount Numeric M The currency amount you want to convert.
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
data String M Contains the dataset of services supported by a particular country 
{
    'statusCode': '00',

    'statusDescription': 'successful',

    'data': {

    'currency_name': 'USD',

    'currency_rate': 2980 }
}
Vend International Services
POST

Make Payment for International service.

Service Information

baseUrl/intl_services/vend
POST
application/json
Parameter Name Type M/O Description
loginId Numeric M Merchant id provided during integration
requestId Numeric M unique id to identify transaction
key String M Merchants (public) key
serviceId String M The serviceId of the plan. it must be part of the services from the get services API call.
amount Numeric M The currency amount of the service. 

{
    'loginId': '{{loginId}}',

    'key': '{{publicKey}}',

    'serviceId': 'INT5',

    'amount': '10',

    'requestId': '{{randomsomethingdigit}}',

    'recipient': '447760929652'

}
Parameter Name Type M/O Description
statusCode Numeric M Status of the transaction. 00 signifies success
statusDescription String M Corresponding description for the status code. 00=Successful
detail String M Contains the details of the payment
detail.extraDetails Array M This can be empty, if a direct top up is done this value would be empty, if a pin recharge is done values would be returned. 
{
    "statusCode": "00",

    "statusDescription": "Successful",

    "detail": {

    "tranxReference": "3240606165442171768",

    "mReference": "27aa2545a0650287",

    "recipient": "447760928328",

    "amount": "10",

    "converted_currency_value": 19485,

    "network": "ASDA Mobile-Mobile Top Up",

    "extraDetails": {

    "confirmCode": "80801846182",

    "pin": "51705318689061",

    "serial": "127472436827",

    "message": "To redeem code There are 3 ways to activate your ASDA Mobile-Mobile Top Up code: Online: 1. Go to your My3 account. 2. 
    Log in with your mobile number, Broadband number, or Username and Password. 3. Follow the instructions on the page and enter your 
    14-digit top up code. Calling:\n\n Call 7823 from the phone you wish to top up.\n When asked by the operator, enter your 14-digit 
    top up code.\n Texting:\n Open a new text message to 75712.\n In the message, type top up + your 14-digit top up code." } }

}