( ! ) Warning: Declaration of Jetpack_IXR_Client::query() should be compatible with IXR_Client::query(...$args) in C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php on line 0
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
( ! ) Warning: Cannot modify header information - headers already sent by (output started at C:\wamp64_2\www\docbase\wp-content\plugins\jetpack\class.jetpack-ixr-client.php:0) in C:\wamp64_2\www\docbase\wp-includes\rest-api\class-wp-rest-server.php on line 1762
{"id":4146,"date":"2021-11-04T16:24:46","date_gmt":"2021-11-04T16:24:46","guid":{"rendered":"http:\/\/sandbox.interswitchng.com\/docbase\/docs\/transfer-service-core-api-document\/transfer-service-core-api\/"},"modified":"2024-10-21T10:30:18","modified_gmt":"2024-10-21T10:30:18","slug":"transfer-service-core-api","status":"publish","type":"docs","link":"https:\/\/sandbox.interswitchng.com\/docbase\/docs\/transfer-service-core-api-document\/transfer-service-core-api\/","title":{"rendered":"Transfer Service Core API"},"content":{"rendered":"\n
Authentication API<\/h2>\n\n\n\n\n\n\n\n
This API handles obtaining an access token for authentication. Use this endpoint to get an access token using client credentials<\/p>\n\n\n\n
The Authentication API endpoints require a Basic authorization header. In addition, the request body is sent as a URL encoded form. As a result, the following headers would be set:<\/p>\n\n\n\n
Authorization:<\/strong> Basic <Base64Encoded string of client_id:client_secret><\/p>\n\n\n\n
The access token that would be used to consume the secure apis<\/td><\/tr>
expires_in<\/td>
The time this token will expire in seconds. Ensure that the token is renewed at least 30 seconds before the token expires to prevent expiry in flight<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
{<\/code> \"error\": \"invalid_request\",<\/code> \"error_description\": \"Missing grant type\"<\/code> }<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/p>\n\n\n\n
Transfer API<\/h2>\n\n\n\n\n\n\n\n
Base URI: https:\/\/sandbox.interswitchng.com<\/h4>\n\n\n\n
1.\u00a0Credit Inquiry Request<\/h2>\n\n\n\n
This endpoint receives a request to confirm if an account specified in destinationAccountNumber<\/strong> <\/em>can be credited with a specified amount . <\/em><\/p>\n\n\n\n
On the successful completion of a credit inquiry, the transaction is logged in Transfer service and awaits a completion update with the same client reference sent in the inquiry or the transaction reference returned in the inquiry response.<\/p>\n\n\n\n
<\/p>\n\n\n\n
Version 1<\/strong><\/h2>\n\n\n\n
Endpoint<\/strong><\/p>\n\n\n\n
POST <base URI>\/transfers\/inquiries\/credit<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Source Customer Bank Verification Number<\/td><\/tr>
3<\/td>
destinationAccountNumber<\/td>
String<\/td>
20<\/td>
Mandatory<\/td>
Destination Account Number<\/td><\/tr>
4<\/td>
destinationInstitutionCode<\/td>
String<\/td>
3<\/td>
Mandatory<\/td>
Institution code , one of the codes assigned in ISW core<\/td><\/tr>
5<\/td>
transactionAmount<\/td>
Long<\/td>
MAX<\/td>
Optional<\/td>
Amount in minor denomination<\/td><\/tr>
6<\/td>
currencyCode<\/td>
String<\/td>
3<\/td>
Mandatory<\/td>
ISO currency code ( ISO Numeric Code)<\/td><\/tr>
7<\/td>
clientRef<\/td>
String<\/td>
50<\/td>
Mandatory<\/td>
Unique reference per transaction<\/td><\/tr>
8<\/td>
mobileNumber<\/td>
String<\/td>
20<\/td>
Optional<\/td>
Internationally formatted mobile number<\/td><\/tr>
9<\/td>
emailAddress<\/td>
String<\/td>
100<\/td>
Optional<\/td>
Customer Email Address<\/td><\/tr>
10<\/td>
paymentLocation<\/td>
String<\/td>
MAX<\/td>
Optional<\/td>
Payment Location<\/td><\/tr>
11<\/td>
channelCode<\/td>
Integer<\/td>
MAX<\/td>
Mandatory<\/td>
Channel ID. Channel Appendix below for channel definitions<\/td><\/tr>
12<\/td>
terminalId<\/td>
String<\/td>
8<\/td>
Optional<\/td>
TerminalID<\/td><\/tr>
13<\/td>
destinationInstitutionAlias<\/td>
String<\/td>
–<\/td>
Optional<\/td>
Institutions Alias. Can be used instead of destinationInstitutionCode<\/td><\/tr>
14<\/td>
mcc<\/td>
String<\/td>
4<\/td>
Optional<\/td>
The classification of the merchant\u2019s type of business product or service.<\/td><\/tr>
14<\/td>
rrn<\/td>
String<\/td>
12<\/td>
Optional<\/td>
A reference number supplied by the system retaining the original source information and used to assist in locating that information or a copy thereof.<\/td><\/tr>
15<\/td>
paymentLocation<\/td>
String<\/td>
40<\/td>
Optional<\/td>
The name and location of the card acceptor (such as a merchant or an ATM). <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Response Message description<\/h4>\n\n\n\n
Field #<\/th>
Field name<\/th>
Data type<\/th>
Description<\/th><\/tr><\/thead>
1<\/td>
responseCode<\/td>
String<\/td>
Response Code<\/td><\/tr>
2<\/td>
responseMessage<\/td>
String<\/td>
Response Message<\/td><\/tr>
3<\/td>
accountName<\/td>
String<\/td>
Account Name<\/td><\/tr>
4<\/td>
accountNumber<\/td>
String<\/td>
Account Number<\/td><\/tr>
5<\/td>
clientRef<\/td>
String<\/td>
Initial reference sent by client if sent, or one auto generated by system<\/td><\/tr>
6<\/td>
transactionReference<\/td>
String<\/td>
Unique transaction reference<\/td><\/tr>
7<\/td>
bankVerificationNumber<\/td>
String<\/td>
Bank Verification Number<\/td><\/tr>
8<\/td>
kycLevel<\/td>
String<\/td>
KYC Level<\/td><\/tr>
9<\/td>
accountType<\/td>
String<\/td>
Current, Savings or Credit<\/td><\/tr>
10<\/td>
accountCurrency<\/td>
String<\/td>
ISO currency<\/td><\/tr>
11<\/td>
address<\/td>
String<\/td>
Receiver\u2019s address. At present this attribute will not be used for any further processing.<\/td><\/tr>
12<\/td>
countryCode<\/td>
String<\/td>
Country code of the transaction. This is the ISO country code.<\/td><\/tr>
13<\/td>
canCredit<\/td>
Boolean<\/td>
If the account validation is successful for credit this will be true. Note: If true allow customer to proceed to complete the credit otherwise, fail the transaction. This is usually because the account is dormant, or the account cannot receive the amount specified.<\/strong><\/td><\/tr>
14<\/td>
systemResponseCode<\/td>
String<\/td>
System Response code that is sometimes included in response in case of exceptions in the system. This helps with issue resolution.<\/td><\/tr>
15<\/td>
action<\/td>
String<\/td>
Action on transaction as received from the middleware<\/td><\/tr>
16<\/td>
settlementStatus<\/td>
Status<\/td>
Settlement status of inquiry transaction. Default settlement status for Inquiry is NEW<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n