Sample Response (success)<\/h5>\n\n\n\n

HTTP Status: 200 <\/code> {<\/code>\"accountType\": \"SAVINGS\",<\/code>\"accountCurrency\": \"NGN\",<\/code>\"address\": \"1 AYANBOYE STREET ANTHONY KOSOFE LAGOS\",<\/code>\"responseCode\": \"00\",<\/code>\"responseMessage\": \"Approved or completed successfully\",<\/code>\"transactionReference\": \"CR|SUN|ABP|250720201707|237233\",<\/code>\"bankVerificationNumber\": \"1234565667\",<\/code>\"kycLevel\": \"1\",<\/code>\"canCredit\": true,<\/code>\"settlementStatus\": \"NEW\",<\/code>\"action\": \"SUCCESS\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Response (invalid account)<\/h5>\n\n\n\n HTTP Status: 409 Conflict<\/code>{\n \"clientRef\": \"abc1222223knkj\", \"responseCode\": \"39\", \"responseMessage\": \"Invalid Account\", \"transactionReference\": \"CR|SUN|ABP|231120201142|244092\", \"canCredit\": false, \"action\": \"FAILURE\" }<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n 3. Account Credit Request With Credit Inquiry Reference or Transaction Reference<\/h3>\n\n\n\n \n\n\n\n This endpoint receives a request to close an open credit inquiry by performing the credit transaction. <\/em>The credit inquiry to be closed is contained in the clientRef <\/strong><\/em>field or transactionReference <\/strong>field.<\/strong> <\/em>The transactionA<\/strong>mount <\/strong><\/em>to be credited is also included in the request.The request is processed and routed to the destination institution to effect the credit. The credit request is pushed for processing and a response is sent back to the calling application.<\/p>\n\n\n\n Endpoint<\/strong>Endpoint<\/strong><\/p>\n\n\n\n POST <base URI>\/accounts\/credits\/completion<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Headers<\/strong><\/p>\n\n\n\n Authorization – Bearer {Passport Access Token}Content-Type: application\/json<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Request Message description<\/h4>\n\n\n\n Field #<\/th> Field name<\/th> Data type<\/th> Max length<\/th> Classification<\/th> Description<\/th><\/tr><\/thead> 1<\/td> transactionAmount<\/td> Long<\/td> MAX<\/td> Mandatory<\/td> Amount in minor denomination<\/td><\/tr> 2<\/td> narration<\/td> String<\/td> 200<\/td> Mandatory<\/td> Narration<\/td><\/tr> 3<\/td> clientRef<\/td> String<\/td> 50<\/td> Required<\/td> Unique reference per client. If present in inquiry, should be the same. N:B<\/strong>: You either client Ref or Transaction Reference in your payload but you cannot use both.<\/strong><\/td><\/tr> 4<\/td> additionalInfo<\/td> String<\/td> MAX<\/td> Optional<\/td> Additional Information. Could contain initial debit details (e.g mobile app implementation)<\/td><\/tr> 5<\/td> transactionReference<\/td> String<\/td> 50<\/td> Required<\/td> Transaction Reference returned from credit inquiry. N:B<\/strong>: You either client Ref or Transaction Reference in your payload but you cannot use both.<\/strong> <\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Message description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Description<\/th><\/tr><\/thead> 1<\/td> transactionReference<\/td> Unique transaction reference<\/td><\/tr> 2<\/td> responseCode<\/td> The response code of the transaction see appendix for response code details<\/td><\/tr> 3<\/td> responseMessage<\/td> The descriptive response message<\/td><\/tr> 4<\/td> status<\/td> The status of the transaction. See transaction status appendix. Use the status mappings to determine if the transaction succeeded or not.<\/td><\/tr> 5<\/td> clientRef<\/td> The clientRef of the transaction<\/td><\/tr> 6<\/td> systemResponseCode<\/td> System Response code that is sometimes included in response in case of exceptions in the system. This helps with issue resolution.<\/td><\/tr> 7<\/td> settlementStatus<\/td> Settlement status of the credit transaction<\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Request one<\/h5>\n\n\n\n {\"transactionAmount\": 300000,\"clientRef\"<\/code> : \"abc1222223knkj\",\"additionalInfo\":\"{\\\"sourceBvn\\\":\\\"1111111\\\",\\\"sourceKycLevel\\\":\\\"1\\\"}\",\"narration\": \"For your wedding\"}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n Sample Request two<\/strong><\/p>\n {\"transactionAmount\": 300000,<\/code>\"transactionReference\": \"CR|SUN|ABP|250720201707|237233\",\"additionalInfo\":\"{\\\"sourceBvn\\\":\\\"1111111\\\",\\\"sourceKycLevel\\\":\\\"1\\\"}\",\"narration\": \"For your wedding\"}<\/code><\/p>\n <\/p>\n <\/p>\n\n\n Sample Response (success)<\/h5>\n\n\n\n HTTP Status: 200 <\/code>{<\/code>\"responseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"CR|FBN|DMD|28032019102410|4237\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Approved by financial institution\"<\/code>,<\/code>\"status\"<\/code>: <\/code>\"SUCCESS\"<\/code>,<\/code>\"clientRef\"<\/code>: <\/code>\"1234-5678\"<\/code> ,<\/code>\"settlementStatus\"<\/code>: <\/code>\"SUCCESSFUL\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n 4. Requery Transfer Request<\/h3>\n\n\n\n \n\n\n\n This endpoint queries a transfer using the original clientRef <\/em><\/strong>and\/or transactionReference <\/em><\/strong>returned by the Transfer Service.<\/p>\n\n\n\n Endpoint<\/strong>Endpoint<\/strong><\/p>\n\n\n\n POST <base URI>\/transfers\/accounts\/credits\/requery<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Headers<\/strong><\/p>\n\n\n\n Authorization – Bearer {Passport Access Token}Content-Type: application\/json<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Request Message description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Data type<\/th> Max<\/th> Classification<\/th> Description<\/th><\/tr><\/thead> 1<\/td> clientRef<\/td> String<\/td> 50<\/td> Optional (if transactionReference is provided) <\/td> Unique reference per institution<\/td><\/tr> 2<\/td> transactionReference<\/td> String<\/td> 16<\/td> Optional (if clientRef is provided)<\/td> Unique transaction reference across institutions, generated and returned by TS<\/td><\/tr><\/tbody><\/table>\n\n\n\n Response Message  field description<\/strong><\/p>\n\n\n\n Field#<\/th> Field name<\/th> Description<\/th><\/tr><\/thead> 1<\/td> transactionReference<\/td> Unique transaction reference<\/td><\/tr> 2<\/td> responseCode<\/td> The response code of the transaction see appendix for response code details<\/td><\/tr> 3<\/td> responseMessage<\/td> The descriptive response message<\/td><\/tr> 4<\/td> status<\/td> The status of the transaction. See transaction status appendix. Use the status mappings to determine if the transaction succeeded or not.<\/td><\/tr> 5<\/td> clientRef<\/td> The clientRef of the transaction<\/td><\/tr> 6<\/td> settlementStatus<\/td> Settlement status of the credit transaction<\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Request With Transaction Reference<\/h5>\n\n\n\n { “transactionReference”: “CR|SUN|FBP|310520202047|226464” }<\/th><\/tr><\/tbody><\/table>\n\n\n\n Sample Request With Client Reference<\/h5>\n\n\n\n { “clientRef”: “SUN|ITF|NA|FBP|1235645654|98776” }<\/th><\/tr><\/tbody><\/table>\n\n\n\n Sample Response (success)<\/strong><\/p>\n\n\n\n HTTP Status: 200<\/code>{<\/code>\"responseCode\"<\/code>: <\/code>\"00\"<\/code>,<\/code>\"transactionReference\"<\/code>: <\/code>\"CR|SUN|FBP|310520202047|226464\"<\/code>,<\/code>\"responseMessage\"<\/code>: <\/code>\"Approved or completed successfully\"<\/code>,<\/code>\"status\"<\/code>: <\/code>\"SUCCESS\"<\/code>,<\/code>\"clientRef\"<\/code>: <\/code>\"SUN|ITF|NA|FBP|1235645654|98776\"<\/code>,<\/code>\"settlementStatus\"<\/code>: <\/code>\"SUCCESSFUL\"<\/code>}<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/li><\/ol>\n\n\n\n <\/p>\n\n\n\n <\/p>\n\n\n\n \n\nList of Receiving Institutions\n\n<\/p>\n\n\n\n Endpoint<\/strong><\/li><\/ol>\n\n\n\n GET <base URI> \/transfers\/institutions<\/td><\/tr><\/tbody><\/table>\n\n\n\n Headers<\/strong><\/p>\n\n\n\n Authorization – Bearer {Passport Access Token} Content-Type: application\/json<\/code><\/td><\/tr><\/tbody><\/table>\n\n\n\n Query Parameters<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Data type<\/th> Option<\/th> Description<\/th><\/tr><\/thead> 1<\/td> perPage<\/td> Integer<\/td> Optional<\/td> The number of institutions per page. The default value is 30 and the maximum value is 200 <\/td> <\/td><\/tr> 2<\/td> page<\/td> Integer<\/td> Optional <\/td> The page number of the institutions to fetch. <\/td> <\/td><\/tr><\/tbody><\/table>\n\n\n\n Sample Request GET host \/transfers\/institutions?perPage=200&page=1<\/p>\n\n\n Sample Response HTTP 200 OK { “total”: 515, “perPage”: 200, “page”: 1, “institutions”: [ { “institutionId”: “1”, “institutionCode”: “AAB”, “institutionName”: “Actual African Bank” }, { “institutionId”: “2”, “institutionCode”: “AGB”, “institutionName”: “Actual Global Bank” }, … ] }<\/p>\n <\/p>\n\n\n Request Message description<\/h4>\n\n\n\n Field#<\/th> Field name<\/th> Data type<\/th> Max<\/th> Classification<\/th> Description<\/th><\/tr><\/thead> 1<\/td> clientRef<\/td> String<\/td> 50<\/td> Required<\/td> Unique reference per institution<\/td><\/tr> 2<\/td> transactionReference<\/td> String<\/td> 16<\/td> Optional (if clientRef is provided)<\/td> Unique transaction reference across institutions, generated and returned by TS<\/td><\/tr><\/tbody><\/table>\n\n\n\n <\/p>\n\n\n\n 5. Appendix<\/h3>\n\n\n\n \n\n\n\n Transaction Statuses<\/h4>\n\n\n\n The status should be used to interprete the transaction response code for simplicity. These can be received during credit completion, requery, and transaction update callback.<\/p>\n\n\n\n Status<\/th> Meaning<\/th><\/tr><\/thead> SUCCESS<\/td> Transaction approved and completed successfully. Credit hit beneficiary account realtime<\/td><\/tr> FAILURE<\/td> Transaction failed permanently<\/td><\/tr> TRANSACTION_IN_PROGRESS<\/td> Transaction status is currently undergoing automated confirmation. Final response will be shared via a call to the requery API<\/td><\/tr> PENDING<\/td> Transaction status unknown and cannot be confirmed from remote institution. Transaction will be settled<\/strong> and dealt with through the arbitration process if necessary. Please treat as SUCCESSFUL<\/td><\/tr> NEW<\/td> This states that the Inquiry can be retried as the Inquiry request is yet to be completed<\/td><\/tr> OPEN<\/td> Transaction Inquiry was successful and transaction is now open for a Credit request<\/td><\/tr> ERROR<\/td> Transaction is in a final state and a user is re-attempting to trigger a duplicate credit request. Recheck transaction details and try again<\/td><\/tr><\/tbody><\/table>\n\n\n\n NOTE: The transaction STATUS gives a true picture of the transaction and should be paid attention to mostly. The response codes<\/em> define the different scenarios that could happen around the transaction processing<\/strong><\/h4>\n\n\n\n Response Codes<\/h4>\n\n\n\n Response Code<\/strong><\/td> Description<\/strong><\/td> Response Message<\/strong><\/td><\/tr> 00<\/td> Transaction was successful<\/td> Approved or completed successfully<\/td><\/tr> 01<\/td> Source institution should be contacted<\/td> Contact source institution<\/td><\/tr> 05<\/td> Do not honour<\/td> Do not honour<\/td><\/tr> 06<\/td> Transaction failed for arbitrary reasons<\/td> General transaction failure<\/td><\/tr> 09<\/td> Transaction is in progress at middleware or other operational reasons.<\/td> Transaction in progress<\/td><\/tr> 10<\/td> CBA timeout at destination<\/td> Transaction in progress<\/td><\/tr> 12<\/td> The transaction is invalid<\/td> Invalid Transaction<\/td><\/tr> 13<\/td> Invalid Amount<\/td> Invalid Amount<\/td><\/tr> 14<\/td> The account type for this account is invalid<\/td> Account type is incorrect<\/td><\/tr> 15<\/td> No such issuer<\/td> Invalid Issuer<\/td><\/tr> 17<\/td> Middleware error returned for operations relating to customer authenticating the debit<\/td> Debit Authentication Error<\/td><\/tr> 19<\/td> Transaction retry limit has been reached. The middleware will no longer attempt this transaction. Except a requery and it receives a response code for which it can retry.<\/td> Pending transaction retry limit reached and status unknown<\/td><\/tr> 20<\/td> Invalid response received from processor<\/td> Invalid response received from CBA<\/td><\/tr> 21<\/td> Middleware received a response code that is not in its mapping configuration table<\/td> Response code not registered<\/td><\/tr> 25<\/td> Transaction record not found<\/td> Transaction not found<\/td><\/tr> 30<\/td> Bad request<\/td> Bad request<\/td><\/tr> 31<\/td> Invalid route configuration for sender<\/td> Route configuration error for issuer institution <\/td><\/tr> 39<\/td> The specified account does not exist<\/td> Invalid account<\/td><\/tr> 40<\/td> The sender account is invalid<\/td> Sender invalid<\/td><\/tr> 45<\/td> The specified account is closed<\/td> Account is closed<\/td><\/tr> 46<\/td> The specified account is dormant<\/td> Account is dormant<\/td><\/tr> 47<\/td> The specified account is blocked<\/td> Account is blocked<\/td><\/tr> 51<\/td> The specified account balance has been reached<\/td> Account balance limit reached<\/td><\/tr> 52<\/td> The TSS at the crediting bank is not sufficiently funded<\/td> Transaction failed. Please contact administrator<\/td><\/tr> 56<\/td> Payment instrument not found to complete transaction<\/td> Payment Instrument not found<\/td><\/tr> 58<\/td> Transaction not allowed on channel specified\/ Channel code has not been mapped\/setup on the middleware or is inactive. No further action was taken.<\/td> Transaction not permitted on channel \/Channel does not exist<\/td><\/tr> 59<\/td> The transaction is marked as suspected fraud and not processed<\/td> Suspected fraud or security breach<\/td><\/tr> 61<\/td> Transaction limit exceeded<\/td> Source transfer limit exceeded<\/td><\/tr> 62<\/td> Withdrawal frequency exceeded<\/td> Withdrawal frequency exceeded<\/td><\/tr> 63<\/td> Security has been violated<\/td> Security Violation<\/td><\/tr> 64<\/td> Authentication token is not valid<\/td> Authentication token is not valid<\/td><\/tr> 79<\/td> Bvn record not maintained<\/td> Account no bvn maintained<\/td><\/tr> 80<\/td> Account name mismatch<\/td> Account name mismatch<\/td><\/tr> 81<\/td> The configured TSS is invalid (does not exist, PND, etc)<\/td> Invalid TSS account<\/td><\/tr> 82<\/td> The configured TSS could not be credited<\/td> Cannot credit TSS account<\/td><\/tr> 91<\/td> Middleware could not reach Core Banking Application \/ Middleware did not get a definite response from Core Banking Application<\/td> Could not reach Remote Service \/ Response timed out while attempting to reach remote service<\/td><\/tr> 92<\/td> Invalid route configuration for destination<\/td> Issue\/Error with routing configuration for the receiving institution<\/td><\/tr> 94<\/td> Transaction is a duplicate and is either in progress <\/td> Duplicate transaction<\/td><\/tr> 97<\/td> A system error occurred. Transaction status not confirmed.<\/td> A system error occurred. Transaction status not confirmed.<\/td><\/tr> 98<\/td> The specified account has reached the limit for this transaction<\/td> Account transaction limit reached<\/td><\/tr> 99<\/td> The transfer rate limit has been reached for the TSS account.<\/td> Transfer frequency reached<\/td><\/tr><\/tbody><\/table>\n\n\n\n Channel Codes<\/h4>\n\n\n\n Channel Code<\/strong><\/td> Description<\/strong><\/td><\/tr> 1<\/td> BANK BRANCH<\/td><\/tr> 2<\/td> WEB<\/td><\/tr> 3<\/td> DIRECT DEBIT<\/td><\/tr> 4<\/td> ATM<\/td><\/tr> 5<\/td> POS<\/td><\/tr> 6<\/td> MOBILE<\/td><\/tr><\/tbody><\/table>\n","protected":false},"author":228,"featured_media":0,"parent":4133,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"spay_email":""},"doc_tag":[],"_links":{"self":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4146"}],"collection":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/users\/228"}],"replies":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/comments?post=4146"}],"version-history":[{"count":11,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4146\/revisions"}],"predecessor-version":[{"id":4439,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4146\/revisions\/4439"}],"up":[{"embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4133"}],"prev":[{"title":"Bank Confirmation Model API","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/transfer-service-core-api-document\/bank-confirmation-model-api\/","href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/docs\/4144"}],"wp:attachment":[{"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/media?parent=4146"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sandbox.interswitchng.com\/docbase\/wp-json\/wp\/v2\/doc_tag?post=4146"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}