SwitchIT REST JSON Sample

Requests & Responses

NB: Please note that this does not cover Bill Payment. Please refer to the SWITCHIT BILL PAYMENT
API WITH SAMPLE REQUEST AND RESPONSE contained in the folder

1
Date Of Revision(dd/mm/yyyy) Page(s) Revised Revision Explanation Change by

31/08/2020 Initial version Initial version Mishael Harry

18/01/2021 All Pages Modification of request and Ross Kuteyi

response

2
Contents

Sandbox Test Parameters.............................................................................................................. 4

Bank Account Fund Transfer Request.............................................................................................6
Bank Account Fund Transfer Response..........................................................................................6
PocketMoni Wallet Fund Transfer Request....................................................................................7
PocketMoni Wallet Fund Transfer Response..................................................................................7
Bank Account Query Request.........................................................................................................7
Bank Account Query Response......................................................................................................7
PocketMoni Wallet Query Request................................................................................................8
PocketMoni Wallet Query Response..............................................................................................8
Transaction Status Request............................................................................................................8
Transaction Status Response..........................................................................................................8
VTU Request..................................................................................................................................9
VTU Response................................................................................................................................9
Balance Enquiry Request................................................................................................................9
Balance Enquiry Response..............................................................................................................9
Bank List Request..........................................................................................................................10
Bank List Response........................................................................................................................10
Bulk Transfer Request...................................................................................................................12
Bulk Transfer Response.................................................................................................................12
Bulk Query Request (Batch)...........................................................................................................13
Bulk Query Response (Batch)........................................................................................................13
Bulk Query Request (Individual)...................................................................................................14
Bulk Query Response (Individual).................................................................................................14

3
 Sandbox Test Parameters

Terminal id 7000000001

Pin 0006

Pin AES encrypted value kghxqwveJ3eSQJip/cmaMQ==

Master key KEd4gDNSDdMBxCGliZaC8w==

Demo Base URL https://demo.etranzactng.com/rest/switchIT/api/v1

Live URL https://www.etranzactng.net/rest/switchIT/api/v1/

Bank account number 2125347370

Bank code 033

Mobile number 2349075766063

Note: you can use any bank account number of your choice just use the corresponding bank codes.

Note: On production, eTranzact supports only clients with TLS v1.2, older versions are disabled and
would be rejected.

Bank Name Bank Code

United Bank for Africa PLC 033

4
Wema 035

Access Bank PLC 044

EcoBank PLC 050

FirstBank PLC 011

Zenith Bank 057

Guaranty Trust Bank PLC 058

Polaris Bank 076

Stanbic-IBTC Bank PLC 039

First City Monument Bank 214

Unity Bank PLC 215

Sterling Bank 232

Fidelity Bank 070

Union Bank 032

Keystone Bank 082

Access (Diamond) Bank 063

Providus Bank 101

Standard Chartered 068

PocketMoni 700

ABMFB 755

CITIBANK NIGERIA LIMITED 023

FSDH MERCHANT BANK LIMITED 501

5
 GLOBUS BANK LIMITED 103

RAND MERCHANT BANK NIGERIA 502

SUNTRUST BANK NIGERIA LIMITED 100

TAJ BANK LIMITED 302

TITAN TRUST BANK LIMITED 102

Fund Transfer Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/fund-transfer

BANK ACCOUNT
REQUEST RESPONSE

{ {
"action":"FT", "direction": "response",
"terminalId":"7000000001", "reference": "09FG2101180053321838MQIC3",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"senderName": "Sndr;Acct;Rcvr", "amount": 0,
"bankCode":"033", "totalFailed": 0,
"amount":"5", "totalSuccess": 0,
"description":"Fund Transfer", "error": "0",
"destination":"2125347370", "message": "Transaction Successful",
"reference":"FTRestTest001", "bulkItems": null,
"endPoint":"A" "otherReference": null,
} "action": "FT",
} "records": null,
"openingBalance": 0,
"closingBalance": 0
}

Note: For the senderName Field, the below are expected:

Sndr: Sender’s Name, Acct: Sender’s Account Number, Rcvr: Recipient’s Name

6
POCKETMONI WALLET
REQUEST RESPONSE
{ {
"action":"FT", "direction": "response",
"terminalId":"7000000001", "reference": "09FG2101189837401938MQIC3",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"senderName": "Sndr;Rcvr;Acct", "amount": 0,
"bankCode":"700", "totalFailed": 0,
"amount":"5", "totalSuccess": 0,
"description":"Fund Transfer", "error": "0",
"destination":"09075766063", "message": "Transaction Successful",
"reference":"FTRestTest002", "bulkItems": null,
"endPoint":"A" "otherReference": null,
} "action": "FT",
} "records": null,
"openingBalance": 0,
"closingBalance": 0
}

Note: For the senderName Field, the below are expected:

Sndr: Sender’s Name, Acct: Sender’s Account Number, Rcvr: Recipient’s Name

Account Query Endpoint:

https://demo.etranzact.com/rest/switchIT/api/v1/account-query
BANK ACCOUNT
REQUEST RESPONSE
{ {
"action":"AQ", "direction": "response",
"terminalId":"7000000001", "reference": "",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"bankCode":"011", "amount": 0,
"amount":"0.0", "totalFailed": 0,
"description":"Account Query", "totalSuccess": 0,
"destination":"3028875212", "error": "0",
"reference":"AQRestTest001", "message": "KUTEYI ROSS ENIAYO",
"endPoint":"A" "bulkItems": null,
} "otherReference": null,
} "action": "AQ",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

7
PocketMoni Wallet
REQUEST RESPONSE
{ {
"action":"AQ", "direction": "response",
"terminalId":"7000000001", "reference": "09FG210118010211115WYI6NF",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"bankCode":"700", "amount": 0,
"amount":"0.0", "totalFailed": 0,
"description":"Account Query", "totalSuccess": 0,
"destination":"09075766063", "error": "0",
"reference":"AQRestTest002", "message": "KUTEYI ~2349075766063 ROSS",
"endPoint":"M" "bulkItems": null,
} "otherReference": null,
} "action": "AQ",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

Transaction Status Endpoint:

https://demo.etranzact.com/rest/switchIT/api/v1/transaction-status

REQUEST RESPONSE
{ {
"action":"TS", "direction": "response",
"terminalId":"7000000001", "reference": null,
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"description":"Status Check", "amount": 0,
"reference":"FTRestTest001", "totalFailed": 0,
"lineType":"OTHERS" "totalSuccess": 0,
} "error": "0",
} "message": "Transaction Successful",
"bulkItems": null,
"otherReference": "FTRestTest001",
"action": "TS",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

8
VTU Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/topup
REQUEST RESPONSE
{ {
"action":"VT", "direction": "response",
"terminalId":"7000000001", "reference": "09FG21011801011453770D1BV",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"amount":100, "amount": 0,
"description":"Virtual TopUp", "totalFailed": 0,
"provider":"GLO", "totalSuccess": 0,
"lineType":"VTU", "error": "0",
"destination":"07051825495", "message": "Transaction Successful",
"reference":"VTURestTest002", "bulkItems": null,
"senderName":"Etranzact Test" "otherReference": null,
} "action": "VT",
} "records": null,
"openingBalance": 0,
"closingBalance": 0
}

Balance Enquiry Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/balance-

enquiry

{ {
"action":"BE", "direction": "response",
"terminalId":"7000000001", "reference": "09FG202101180057441240450",
"transaction": { "companyId": null,
"pin":"kghxqwveJ3eSQJip/cmaMQ==", "date": null,
"description":"Balance Enquiry", "amount": 0,
"reference":"BERestTest001" "totalFailed": 0,
} "totalSuccess": 0,
} "error": "0",
"message": "10099.87",
"bulkItems": null,
"otherReference": null,
"action": "BE",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

9
Bank List Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/banks

REQUEST RESPONSE
{ {
"actio "direction": "response",
n":"BL", "reference": "09FG210118020641323B2THUF",
"companyId": null,
"termi "date": null,
nalId":"70 "amount": 0.0,
00000001", "totalFailed": 0,
"totalSuccess": 0,
"trans "error": "0",
action": { "message": "<Banks><bank><bankCode>500</bankCode><bankName>eTranzact Intl Plc</ba
nkName><bankAlias>eTranzact</bankAlias></bank><bank><bankCode>771</bankCode><bankName
"p >IMSU
in":"kghxq MICROFINANCE BANK</bankName><bankAlias>MFB</bankAlias></bank><bank><bankCode>770</ban
wveJ3eSQJi kCode><bankName>ALVANA MICROFINANCE BANK</bankName><bankAlias>OWERRI</bankAlias></ban
p/cmaMQ==" k><bank><bankCode>767</bankCode><bankName>Ilaro Poly mfb</bankName><bankAlias>MFI</ba
, nkAlias></bank><bank><bankCode>764</bankCode><bankName>Unical mfb</bankName><bankAli
"r as>MFI</bankAlias></bank><bank><bankCode>761</bankCode><bankName>FED POLY NASARAWA MF
eference": B</bankName><bankAlias>Nasarawa p</bankAlias></bank><bank><bankCode>754</bankCode><ba
"BLRestTes nkName>IMO STATE MFB</bankName><bankAlias>IMO STATE</bankAlias></bank><bank><bankCode
t001" >738</bankCode><bankName>3LineCard Managenent LTD</bankName><bankAlias>3LineCard</ban
} kAlias></bank><bank><bankCode>788</bankCode><bankName>Ogui Urban MFB</bankName><bankA
} lias>OUMFB</bankAlias></bank><bank><bankCode>797</bankCode><bankName>FCE OBUDU MFB</b
ankName><bankAlias>FCE</bankAlias></bank><bank><bankCode>798</bankCode><bankName>ISUO
FIA NFB</bankName><bankAlias>null</bankAlias></bank><bank><bankCode>785</bankCode><ba
nkName>ASO SAVINGS</bankName><bankAlias>ASOMOBILE</bankAlias></bank><bank><bankCode>7
00</bankCode><bankName>PocketMoni</bankName><bankAlias>PocketMoni</bankAlias></bank><
bank><bankCode>731</bankCode><bankName>SmartMicro MFB</bankName><bankAlias>SMFB</bank
Alias></bank><bank><bankCode>732</bankCode><bankName>Parallex MFB</bankName><bankAlia
s>eTranzact</bankAlias></bank><bank><bankCode>800</bankCode><bankName>Kaduna Polytech
nic MFB</bankName><bankAlias>KADPOLY MF</bankAlias></bank><bank><bankCode>710</bankCo
de><bankName>PocketMoni - Access</bankName><bankAlias>PocketMoni</bankAlias></bank><b
ank><bankCode>781</bankCode><bankName>FUTO MICROFINANCE BANK</bankName><bankAlias>FUT
O MFB</bankAlias></bank><bank><bankCode>714</bankCode><bankName>eTz MFB Global Teller

10
 Scheme</bankName><bankAlias>PocketMoni</bankAlias></bank><bank><bankCode>602</bankCo
de><bankName>NIBSS Routed MMO</bankName><bankAlias>MMO</bankAlias></bank><bank><bankC
ode>301</bankCode><bankName>Jaiz Bank</bankName><bankAlias>Jaiz Bank</bankAlias></ban
k><bank><bankCode>768</bankCode><bankName>ekuombe mfb</bankName><bankAlias>MFI</bankA
lias></bank><bank><bankCode>765</bankCode><bankName>Highland mfb</bankName><bankAlias
>MFI</bankAlias></bank><bank><bankCode>763</bankCode><bankName>Fed Poly Nekede mfb</
bankName><bankAlias>MFI</bankAlias></bank><bank><bankCode>758</bankCode><bankName>Yel
lowAccount</bankName><bankAlias>YellowAcco</bankAlias></bank><bank><bankCode>719</ban
kCode><bankName>UBA Social Banking</bankName><bankAlias>UBA</bankAlias></bank><bank><
bankCode>796</bankCode><bankName>Abia State University MFB</bankName><bankAlias>ABSU<
/bankAlias></bank><bank><bankCode>799</bankCode><bankName>Kenya Commercial Bank</bank
Name><bankAlias>null</bankAlias></bank><bank><bankCode>786</bankCode><bankName>Access
Solutions Ltd</bankName><bankAlias>AccSol</bankAlias></bank><bank><bankCode>784</ban
kCode><bankName>URBAN MICROFINANCE</bankName><bankAlias>URBAN MICR</bankAlias></bank>
<bank><bankCode>702</bankCode><bankName>Kegow</bankName><bankAlias>Kegow</bankAlias><
/bank><bank><bankCode>068</bankCode><bankName>STandard Chartered Bank</bankName><bank
Alias>eTranzact</bankAlias></bank><bank><bankCode>783</bankCode><bankName>POLYUWANA M
FB</bankName><bankAlias>POLYUWANA</bankAlias></bank><bank><bankCode>782</bankCode><ba
nkName>Kaduna Polytechnic MFB</bankName><bankAlias>KADPOLY MF</bankAlias></bank><bank
><bankCode>735</bankCode><bankName>Parallex MFB - Bank</bankName><bankAlias>eTranzact
</bankAlias></bank><bank><bankCode>715</bankCode><bankName>eTz LSLB Global Teller Sch
eme</bankName><bankAlias>PocketMoni</bankAlias></bank></Banks>",
"bulkItems": null,
"otherReference": null,
"action": "BL",
"records": null,
"openingBalance": 0.0,
"closingBalance": 0.0
}

11
Bulk Transfer Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/bulk-transfer
REQUEST RESPONSE

12
{ {
"action": "BT", "direction": "response",
"terminalId": "7000000001", "reference": "09FG210118005839171BQS6I7",
"transaction": { "companyId": "TestCompanyID",
"companyId": "TestCompanyID", "date": null,
"pin": "kghxqwveJ3eSQJip/cmaMQ==", "amount": 15,
"amount": 15, "totalFailed": 0,
"reference": "BTTestBT0002", "totalSuccess": 3,
"senderName": "Test Accounts", "error": "0",
"endPoint": "A", "message": "Transaction Successfull",
"terminalCard": false, "bulkItems": null,
"bulkItems": { "otherReference": null,
"bulkItem": [ "action": "BT",
{ "records": null,
"uniqueId": "BTTestBT04", "openingBalance": 0,
"bankCode": "011", "closingBalance": 0
"accountId": "3028875212", }
"beneficiaryName": "Peter Azuka",
"narration": "narration",
"amount": 5.0
},
{
"uniqueId": "BTTestBT05",
"bankCode": "033",
"accountId": "2125347370",
"beneficiaryName": "Peter Azuka",
"narration": "narration",
"amount": 5.0
},
{
"uniqueId": "BTTestBT06",
"bankCode": "058",
"accountId": "0129915440",
"beneficiaryName": "Peter Azuka",
"narration": "narration",
"amount": 5.0
}
]
}
}
}

13
Bulk Query Endpoint: https://demo.etranzact.com/rest/switchIT/api/v1/bulk-query
BATCH
REQUEST RESPONSE
{ {
"action": "BQ", "direction": "response",
"terminalId": "7000000001", "reference": "09FG2101180100299722UFHRP",
"transaction": { "companyId": "TestCompanyID",
"companyId": "TestCompanyID", "date": null,
"pin": "kghxqwveJ3eSQJip/cmaMQ==", "amount": 15,
"amount": 15, "totalFailed": 0,
"reference": "BQTestBT002", "totalSuccess": 3,
"senderName": "Test Accounts", "error": "0",
"endPoint": "B", "message": "Successful",
"terminalCard": false, "bulkItems": {
"bulkItems": { "bulkItem": [
"bulkItem": [ {
{ "uniqueId": "BTTestBT04",
"uniqueId": "BTTestBT04" "merchantCode": null,
}, "bankCode": null,
{ "terminalId": "7000000001",
"uniqueId": "BTTestBT05" "accountId": "3028875212",
}, "sortCode": null,
{ "beneficiaryName": "Peter Azuka",
"uniqueId": "BTTestBT06" "narration": "narration",
} "amount": 5,
] "status": "0",
} "message": "SUCCESSFUL"
} },
} {
"uniqueId": "BTTestBT05",
"merchantCode": null,
"bankCode": null,
"terminalId": "7000000001",
"accountId": "2125347370",
"sortCode": null,
"beneficiaryName": "Peter Azuka",
"narration": "narration",
"amount": 5,
"status": "0",
"message": "SUCCESSFUL"
},
{
"uniqueId": "BTTestBT06",
"merchantCode": null,
"bankCode": null,
"terminalId": "7000000001",
"accountId": "0129915440",

14
 "sortCode": null,
"beneficiaryName": "Peter Azuka",
"narration": "narration",
"amount": 5,
"status": "0",
"message": "SUCCESSFUL"
}
]
},
"otherReference": null,
"action": "BQ",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

INDIVIDUAL
REQUEST RESPONSE
{ {
"action": "BQ", "direction": "response",
"terminalId": "7000000001", "reference": "7000000001BTTestBT04",
"transaction": { "companyId": "TestCompanyID",
"companyId": "TestCompanyID", "date": null,
"pin": "kghxqwveJ3eSQJip/cmaMQ==", "amount": 0,
"amount": 0.0, "totalFailed": 0,
"reference": "BTTestBT04", "totalSuccess": 0,
"senderName": "Test Accounts", "error": "0",
"endPoint": "I", "message": "Successful",
"terminalCard": false "bulkItems": {
} "bulkItem": []
} },
"otherReference": null,
"action": "BQ",
"records": null,
"openingBalance": 0,
"closingBalance": 0
}

15