Headers

Please refer to attached document to learn how to compute the required headers for authentication.

ISA01000I Interswitch Services API Specification

Authentication Headers

Content Type:application/json Authorization:InterswitchAuth SUifhfjdbxbkfhj132hdfhjshfjhsv Signature: kuTwggg/3gdgdghs= Timestamp: 1434455667788 Nonce:7333394444423754333 SignatureMethod:SHA1 TerminalID: 3DMO0001

Request Parameters

Fields	M/O	Length	Format	Description
Initiating Entity Code	M	<=5	Alphanumeric	Client Entity Code issued by Interswitch
TransferCode	M	<=12	Numeric	Unique Transfer code generated on Client’s system and sent in DoTransfer request. 4 digit transfer code prefix will be provided by Interswitch.
Sender
Lastname	M	<=50	Alphanumeric	Sender Last name
Othernames	M	<=50	Alphanumeric	Other names of Sender
Email	O	<=50	Alphanumeric	Email Address of Sender (Mandatory if customer should receive notification)
Phone	O	<=25	Alphanumeric	Phone Number of sender (Mandatory if customer should receive notification)

Beneficiary
Lastname	M	<=50	Alphanumeric	Sender Last name
Othernames	M	<=50	Alphanumeric	Other names of Sender
Email	O	<=50	Alphanumeric	Email Address of Sender (Mandatory if customer should receive notification)
Phone	O	<=25	Alphanumeric	Phone Number of sender (Mandatory if customer should receive notification)

Initiation Amount	M		Numeric	Amount to be sent to the beneficiary in small denomination. Initiation Amount and Termination amount should be the same.

Initiation Channel	M		Numeric	See Payment channel in Appendix. Channel must always be 7.

InitiationPaymentMethodCode	M	2	Alphanumeric	Payment Method Code of where transfer is being initiated from. InitiationPaymentMethodCodemust always be CA.

InitiationCurrencyCode	M	3	Alphanumeric	ISO 4217 standard currency code

TerminatingPaymentMethodCode	M	2	Alphanumeric	One of the payment method codes for where the transfer is to be terminated. TerminatingPaymentMethodCode must always be AC.

TerminatingAmount	M		Numeric	Amount that will be received by beneficiary in small denomination

TerminatingCurrencyCode	M	3	Alphanumeric	ISO 4217 standard currency code

TerminatingCountryCode	M	2	Alphanumeric	ISO 4217 standard currency code

TerminatingAccountNumber	M	<=50	Alphanumeric	Account number/Card number of beneficiary. Account Number should be the 10 digits Nuban Account Number of the beneficiary.


TerminatingAccountType	M	2	Alphanumeric	For bank accounts only. 10 = Savings account 20 = Current Account 00 = default value / not sure

TerminatingEntityCode	M	<=5	alphanumeric	Code of bank/agent where transfer should be collected

TerminatingEntityLocationCode	O	<=5	Alphanumeric	Code of bank/agent location where transfer should be collected, For cash receivable transfers only.
TerminatingStateCode	O	<=5	Alphanumeric	State where the transfer can be collected, For cash receivable transfers only.

CashReceivableTypeCode	O	2	Alphanumeric	For cash receivable transfers only.


IdentificationTypeCode	O	2	Alphanumeric	For cash receivable transfers only.


MAC	M			Message authentication code, for message integrity. Should be computed with SHA512 algorithm of the string in Request MAC fields below

Request MAC Computation

MAC should be computed with SHA512 algorithm of the string below:

macCipher = InitiatingAmount + InitiatingCurrencyCode + InitiatingPaymentMethodCode + TerminatingAmount + TerminatingCurrencyCode
+ TerminatingPaymentMethodCode + TerminatingCountryCode

MAC = SHA512(macCipher)

Funds Transfer Request

Sample Request

{
  “mac”: “9f4e4f53c57be63e1f08d8f07a7bc1a9461e4a7d5304043daa1ef54bd727b6cde148f4fbfc5e2ad8c4a60f78dfa76304de671fbeb70657b1628f14b6b6baa5e1”,
  “beneficiary”: {
    “lastname”: “Test”,
    “othernames”: “Transfer”
  },
  “initiatingEntityCode”: “DMO”,
  “initiation”: {
    “amount”: “100000”,
    “channel”: “7”,
    “currencyCode”: “566”,
    “paymentMethodCode”: “CA”
  },
  “sender”: {
    “email”: “testtransfer@test.com”,
    “lastname”: “Testing”,
    “othernames”: “Test”,
    “phone”: “0732246413”
  },
  “termination”: {
    “accountReceivable”: {
      “accountNumber”: “0014261063”,
      “accountType”: “10”
    },
    “amount”: “100000”,
    “countryCode”: “NG”,
    “currencyCode”: “566”,
    “entityCode”: “058”,
    “paymentMethodCode”: “AC”
  },
  “transferCode”: “145334232423423”
}

Funds Transfer Response

A HTTP response code 200 is sent back for a success
Response Parameters

Field	Description
ResponseCode	Response Code
MAC	Response MAC
TransactionReference	Unique Transaction reference generated by Interswitch
TransactionDate ResponseCodeGrouping	Date and Time of Transaction A response of status is returned (SUCCESS, FAILED, or PENDING)

Response MAC Fields

ResponseCodeTransactionReferenceTransferCode
HTTP 200

Sample Response

PHP
{
 "ResponseCode": 90000,
 "ResponseCodeGrouping": "SUCCESSFUL",
 "TransactionReference": "UYU|LOC|CA|UBA|AC|180876100046|JNCYUPYN",
 "Pin": "",
 "TransferCode": 182890812522,
 "MAC": "F87BC044A5TYHG5BD9AC41CA005065D7391CB3F173F85B4POI8FF7A79DC5A37BE105C1BD8653B850FD68BA803D976AA8E91F0A6285398UYT279847F60D58F4C0",
 "TransactionDate": "18/Sep/2018 10:00:46"
}

				
					
				1
2
3
4
5
6
7
8
9

						{
 "ResponseCode": 90000,
 "ResponseCodeGrouping": "SUCCESSFUL",
 "TransactionReference": "UYU|LOC|CA|UBA|AC|180876100046|JNCYUPYN",
 "Pin": "",
 "TransferCode": 182890812522,
 "MAC": "F87BC044A5TYHG5BD9AC41CA005065D7391CB3F173F85B4POI8FF7A79DC5A37BE105C1BD8653B850FD68BA803D976AA8E91F0A6285398UYT279847F60D58F4C0",
 "TransactionDate": "18/Sep/2018 10:00:46"
}

					

			

NOTE: Kindly ensure the QueryTransaction request is made no earlier than 360secs after DoTransfer response has been received or the timeout period has elapsed. Also, ensure your request timeout is set to a minimum of 60secs for DoTransfer calls.