8<\/td> | initiatingInstitutionCode<\/td> | String<\/td> | Required<\/td> | TS Institution code for initiating institution<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\nurl \/endpoint goes here<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nHeaders<\/strong><\/p>\n\n\n\n\"Content-Type\"<\/code>:<\/code>\"application\/json\"<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nSample Plain Request<\/h5>\n\n\n\nSample request<\/strong><\/p>\n\n\n\n{<\/code>\"requestTime\"<\/code>: <\/code>\"15-06-2020 14:39\"<\/code>,<\/code>\"institutionCode\"<\/code>: <\/code>\"FBN\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"CR|ZIB|FBN|150620201439|402452\"<\/code>,<\/code>\"transactionAmount\"<\/code>: 3250000,<\/code>\"initiatingInstitutionCode\"<\/code>: <\/code>\"ZIB\"<\/code>,<\/code>\"accountNumber\"<\/code>: <\/code>\"3059198727\"<\/code>,<\/code>\"currencyCode\"<\/code>: <\/code>\"NGN\"<\/code>,<\/code>\"channelCode\"<\/code>: <\/code>\"2\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nSample Encrypted Request<\/h4>\n\n\n\nSample request<\/strong><\/p>\n\n\n\n{<\/code>\"request\"<\/code>:<\/code>\"hQEMA0DlRChs2dNlAQf\/WL0gFBvazSpeU+hGCBK7MZxRJyaRMeZxL443IS1vLET1iYMMPnET4T\/FseWTuIOj9LS86a+y1U3TfL\/r+P0Wjs\/B9QDL7Vfx8ahBv7yOJGdcYUR3Rtrt7B1ybdEWpq3kw81pAwqIJNOlUnksncQnsPozsr2Ogh\/YF9wevOODgvRyyKYcWxVhBku8cF5AyWicsjNqnShYZbk9r0sjt6aqKa0VGbddcT6zdA3aOYLSeIFEsmT\/CtFglHZB1fJlaYlKQ460cQqOKasZIERy9hWECB\/trNyf0wDTvVkdtL6Bhp\/w5jvySoWnnXZmryChYFMmK5r+9INNFC8GGTVGkfG9XsnAI8p8gUCgmkYshElC53asGos5BlI0tg+VYgO2xqGaxqooSvrppm5q\/Nf9e6ZcaerUeWFMfgIXvW0ZcuSfYEAZbXdcnm\/zNJbVZHiQZ50tGr\/Om1uEtD+iiKfoaxkfZbC1WHQl8wMW+6qn1RpsaV6Ia+AtM5t7SdWqN1fK3RXyzQanvxDFUzyvlbykfsFmWnaN9HMYQ6n4o9kyKD+QmXFFvtYDroQB1JsIk0Ge94KvqVzKsC9oWWMDGobuJyJyAGpplovxbm\/4ZAWDWnP+EzZHWdC9cTWE1XKb7rC7VNMVtwZexHH6\"<\/code>\"request\"<\/code>:<\/code>\"hQEMA0DlRChs2dNlAQf\/WL0gFBvazSpeU+hGCBK7MZxRJyaRMeZxL443IS1vLET1iYMMPnET4T\/FseWTuIOj9LS86a+y1U3TfL\/r+P0Wjs\/B9QDL7Vfx8ahBv7yOJGdcYUR3Rtrt7B1ybdEWpq3kw81pAwqIJNOlUnksncQnsPozsr2Ogh\/YF9wevOODgvRyyKYcWxVhBku8cF5AyWicsjNqnShYZbk9r0sjt6aqKa0VGbddcT6zdA3aOYLSeIFEsmT\/CtFglHZB1fJlaYlKQ460cQqOKasZIERy9hWECB\/trNyf0wDTvVkdtL6Bhp\/w5jvySoWnnXZmryChYFMmK5r+9INNFC8GGTVGkfG9XsnAI8p8gUCgmkYshElC53asGos5BlI0tg+VYgO2xqGaxqooSvrppm5q\/Nf9e6ZcaerUeWFMfgIXvW0ZcuSfYEAZbXdcnm\/zNJbVZHiQZ50tGr\/Om1uEtD+iiKfoaxkfZbC1WHQl8wMW+6qn1RpsaV6Ia+AtM5t7SdWqN1fK3RXyzQanvxDFUzyvlbykfsFmWnaN9HMYQ6n4o9kyKD+QmXFFvtYDroQB1JsIk0Ge94KvqVzKsC9oWWMDGobuJyJyAGpplovxbm\/4ZAWDWnP+EzZHWdC9cTWE1XKb7rC7VNMVtwZexHH6\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nResponse Message field description<\/h4>\n\n\n\nField#<\/th> | Field name<\/th> | Data Type<\/th> | Required<\/th> | Description<\/th><\/tr><\/thead> |
---|
1<\/td> | firstName<\/td> | String<\/td> | Optional<\/td> | Beneficiary first name<\/td><\/tr> | 2<\/td> | lastName<\/td> | String<\/td> | Optional<\/td> | Beneficiary last name<\/td><\/tr> | 3<\/td> | accountName<\/td> | String<\/td> | Required<\/td> | Core banking account name<\/td><\/tr> | 4<\/td> | accountType<\/td> | String<\/td> | Optional<\/td> | Current, Savings, or Credit<\/td><\/tr> | 5<\/td> | accountCurrency<\/td> | String<\/td> | Required<\/td> | ISO currency<\/td><\/tr> | 6<\/td> | address<\/td> | String<\/td> | Optional<\/td> | Beneficiary address<\/td><\/tr> | 7<\/td> | responseCode<\/td> | String<\/td> | Required<\/td> | TS response code.See Response Code Appendix below for response code mapping<\/td><\/tr> | 8<\/td> | institutionResponseMessage<\/td> | String<\/td> | Required<\/td> | Bank response message<\/td><\/tr> | 9<\/td> | transactionReferenceNumber<\/td> | String<\/td> | Required<\/td> | The TS transaction reference number sent in request<\/td><\/tr> | 10<\/td> | processTime<\/td> | String<\/td> | Required<\/td> | Date the request was processed on the bank\u2019s end in dd-MM-yyyy HH:mm:ss format<\/td><\/tr> | 11<\/td> | institutionReference<\/td> | String<\/td> | Optional<\/td> | Core Banking transaction reference for the account validation request<\/td><\/tr> | 12<\/td> | bankVerificationNumber<\/td> | String<\/td> | Optional<\/td> | The BVN of the customer<\/td><\/tr> | 13<\/td> | kycLevel<\/td> | String<\/td> | Optional<\/td> | The KYCLevel of the customer<\/td><\/tr> | 14<\/td> | canCredit<\/td> | Boolean<\/td> | Required<\/td> | Account number and transaction amount are validated real-time to ascertain that the account can be credited.Validation checks to set this value include account credit limits, dormancy or inactiveness. (including other checks specific to your bank)<\/td><\/tr> | 15<\/td> | canDebit<\/td> | Boolean<\/td> | Optional<\/td> | Account number and transaction amount are validated real-time to ascertain that the account can be debitted.Validation checks to set this value include account debit limits, account balance, minimum balance, dormancy or inactiveness. (including other checks specific to your bank)<\/td><\/tr> | 16<\/td> | action<\/td> | String<\/td> | Required<\/td> | Indicates status of inquiry could be SUCCESS or FAILURE<\/td><\/tr> | 17<\/td> | institutionResponseCode<\/td> | String<\/td> | Required<\/td> | Response code from Institution CBA before mapping to TS Response Code<\/td><\/tr><\/tbody><\/table>\n\n\n\nSample Plain Response (success)<\/h5>\n\n\n\n{<\/code>\"lastName\"<\/code>: null,<\/code>\"address\"<\/code>: null,<\/code>\"accountName\"<\/code>: <\/code>\"BAKARE KAMORUDEEN ADEWALE\"<\/code>,<\/code>\"transactionReferenceNumber\"<\/code>: <\/code>\"CR|ZIB|FBN|150120211439|402452\"<\/code>,<\/code>\"institutionReference\"<\/code>: <\/code>\"88A402ED5F1744B5A3D7086CC4B8BBD1\"<\/code>,<\/code>\"accountType\"<\/code>: null,<\/code>\"accountCurrency\"<\/code>: <\/code>\"NGN\"<\/code>,<\/code>\"canCredit\"<\/code>: <\/code>true<\/code>,<\/code>\"processTime\"<\/code>: <\/code>\"15-06-2020 14:39:56\"<\/code>,<\/code>\"responseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"canDebit\"<\/code>: null,<\/code>\"firstName\"<\/code>: null,<\/code>\"kycLevel\"<\/code>: null,<\/code>\"institutionResponseMessage\"<\/code>: <\/code>\"Success\"<\/code>,<\/code>\"institutionResponseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"action\"<\/code>: <\/code>\"SUCCESS\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Success\"<\/code>,<\/code>\"bankVerificationNumber\"<\/code>: null<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nSample Plain Response (failure)<\/h5>\n\n\n\n{<\/code> \"transactionReferenceNumber\"<\/code>: <\/code>\"CR|ZIB|FBN|150120211439|402452\"<\/code>,<\/code>\"institutionReference\"<\/code>: <\/code>\"88A402ED5F1744B5A3D7086CC4B8BBD1\"<\/code>,<\/code>\"accountType\"<\/code>: null,<\/code>\"canCredit\"<\/code>: <\/code>false<\/code>,<\/code>\"processTime\"<\/code>: <\/code>\"15-06-2020 14:39:56\"<\/code>,<\/code>\"responseCode\"<\/code>: <\/code>\"39\"<\/code>,<\/code>\"canDebit\"<\/code>: null,<\/code>\"firstName\"<\/code>: null,<\/code>\"kycLevel\"<\/code>: null,<\/code>\"institutionResponseMessage\"<\/code>: <\/code>\"failed\"<\/code>,<\/code>\"institutionResponseCode\"<\/code>: <\/code>\"39\"<\/code>,<\/code>\"action\"<\/code>: <\/code>\"FAILURE\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"failed\"<\/code>,<\/code>\"bankVerificationNumber\"<\/code>: null<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nSample Encryped Response (success)<\/h5>\n\n\n\n{<\/code>\"response\"<\/code>:<\/code>\"hQEMAxpO4GU1IXNDAgf\/f+Nj1AHkFZiYJ38H8kQX9IPyMrkqdqw8LvuQAjPT4oHi36xnrllQpOcwAwc4aTmImky2SovEGt3ZoUSSX57C6mwBbRo0N57bb\/TSK000oqtIvgq2eWdqhhqM5xsOR2h5vIHEYFbFo6ZkA0NyOVSCzIbFuVe0HodXRbpDLrLlbduRol0h007s4Gw+moz+Dsdrb2EnGBjvhdpuxd7dD7im8HiFS3vrf1Lu6N5Mg76xFk+gSTDTgqlvLUzOoLDpZHUMsl5DsVDhPMNs6oIMiuFSi7fTVK412uMb222zq\/DvrdEFcvjy9n55fNLxyEh8nDIx32mXNzoCIYnk+w7ewGrdJ8nAmo\/BcX\/s2l\/DxFNB\/u7bCYoV4QjgaNNZO+X4B+KoygGS5cM3xk26\/A3cf2TmJZnvz90S6tsaSD31jRTfE6T+kHdTZiuLtz6T0E3oToO4kib2Gw6izijDqNyUmR+XDKGg41rJARScAwAkV7378Ye1pUXqBPCqXjP\/jH5VNMig6jEoxKUaQ0KoIGrXztvf1a8ZVnC5asZq0iw7AhTzGmv9PBknRMymdtJ2C+rIiLwxXhSxn2WXqbT2ZTArrga95Mgm4dLOErEaOmCzQfbpkq3kZgWIMBAlgK2cgzSSBSsmidhaTgTbaKx57SA+x2WQ35jZ2mICFtfG2J1jaSUGy64ybyLh\/FPMnREAXKs95LLtlgfCTXaRQdnOujmwj77+rjNBO9MXJ7E\/l8WSqVpMrpI70nyp2mzxspuZI\/ltV+7BW7mArK1DM8KR5x4shHKaIrmhGju5WJw\/3+6xYC0=\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nCredit Instruction API (Funds Transfer Single Credit)<\/h3>\n\n\n\nThe credit instruction api will be used by the transfer service to credit any beneficiary within the bank.<\/p>\n\n\n\n Request Message description<\/h4>\n\n\n\nField#<\/th> | Field name<\/th> | Data type<\/th> | Required<\/th> | Description<\/th><\/tr><\/thead> |
---|
1<\/td> | destinationAccountName<\/td> | String<\/td> | Required<\/td> | Beneficiary account name<\/td><\/tr> | 2<\/td> | destinationAccountNumber<\/td> | String<\/td> | Required<\/td> | Beneficiary account number<\/td><\/tr> | 3<\/td> | transactionAmount<\/td> | Long (Minor denomination)<\/td> | Required<\/td> | Amount to be credited to beneficiary<\/td><\/tr> | 4<\/td> | narration<\/td> | String<\/td> | Required<\/td> | Transaction narration<\/td><\/tr> | 5<\/td> | currencyCode<\/td> | String<\/td> | Required<\/td> | ISO currency code<\/td><\/tr> | 6<\/td> | transactionReference<\/td> | String<\/td> | Required<\/td> | Unique transaction reference. Credit transaction should fail when reference is a duplicate<\/td><\/tr> | 7<\/td> | channelCode<\/td> | String<\/td> | Required<\/td> | Channel code<\/td><\/tr> | 8<\/td> | requestTime<\/td> | String<\/td> | Required<\/td> | dd-MM-yyyy HH:mm:ssFor the purpose of security, it is advised that this value is taken into consideration before onward processing of a request. <\/td><\/tr> | 9<\/td> | Signature <\/td> | String<\/td> | Required<\/td> | HmacSHA1(nonce+accountName+accountNumber+transactionAmount+currencyCode+transRef+destinationInstitutionCode+channelCode)This request parameter is contained in the header of the request and is to be validated by the bank. The HMAC key is to be provided and verified by the bank for the UAT and Production environment.The Nonce and Algorithm values are also provided in the request header <\/td><\/tr> | 10<\/td> | transactionLocation<\/td> | String<\/td> | Required<\/td> | Transaction Location<\/td><\/tr> | 11<\/td> | additionalInfo <\/td> | String<\/td> | Optional<\/td> | Additional information pertaining to transaction.<\/td><\/tr> | 12<\/td> | settlementAccount<\/td> | String<\/td> | Optional<\/td> | Sent in FX transactions. Helps the remote institution identify the TSS Account such transactions will be settled to<\/td><\/tr><\/tbody><\/table>\n\n\n\n Endpoint<\/strong><\/p>\n\n\n\nurl \/endpoint goes here<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\nHeaders<\/strong><\/p>\n\n\n\n\"Content-Type\"<\/code>:<\/code>\"application\/json\"<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Plain Request<\/h5>\n\n\n\n
Sample request<\/strong><\/p>\n\n\n\n{<\/code>\"transactionLocation\"<\/code>: <\/code>\"IRO,T,17190001059661,myself, myself,LaNG\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"CR|ZIB|FBN|150620201439|402452\"<\/code>,<\/code>\"destinationAccountNumber\"<\/code>: <\/code>\"3059198727\"<\/code>,<\/code>\"sourceAccountNumber\"<\/code>: <\/code>\"1015179455\"<\/code>,<\/code>\"destinationAccountName\"<\/code>: <\/code>\"BAKARE KAMORUDEEN ADEWALE\"<\/code>,<\/code>\"debitSourceInstitutionAccount\"<\/code>: <\/code>true<\/code>,<\/code>\"requestTime\"<\/code> |
|
|
|
|
|
|
|
|
|
|
|
|