User Login
The User Login section allows users to securely authenticate themselves and access their account information. By providing their email and password, users can log in to the system and perform various actions such as viewing transaction history, managing payouts, and updating account settings. This section ensures a seamless and secure user experience for accessing the Payout API functionality.
Body Parameters
The email address associated with the user account for logging in.
The password for the user account for authentication during login.
Response
Response Attributes
Show child attributes
What made this section unhelpful for you?
Base URL
Test Environment:
https://api.dev.cslpay.io
Response
{
"status": "SUCCESS",
"data": {
"username": "komowele@gmail.com",
"phoneNumber": "2347033872435",
"firstName": "kimberley",
"lastName": "Omowele",
"partnerCode": "790598",
"realmRoles": [
"DEFAULT",
"IMTO_ADMIN"
],
"accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJoTkc3SmotWjRSX1dtNTEtcGpJWDlWTlBsNlljLUwxNHhZNzB0NDNBQkJ3In0.eyJleHAiOjE3MzQ2NTk3MzEsImlhdCI6MTczNDYyMzczMSwianRpIjoiN2ZmODhhYmYtZTJmMy00ZGZhLWI5NjAtODAwYTFlZTdkNzA1IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5tZ3QuY3NscGF5LmlvL3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNTVkMGM1MGUtNGZiNi00NTUzLTllMWQtZTZlNmYwZGYyNzBmIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiYWRtaW4tY2xpIiwic2Vzc2lvbl9zdGF0ZSI6IjUwN2M1OTMyLTQ5ZTQtNDQzOS1iNDMwLWVlN2JkNGZiM2Y3OSIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1tYXN0ZXIiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiaW10by1hZG1pbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicm9sZXMgZW1haWwgcHJvZmlsZSIsInNpZCI6IjUwN2M1OTMyLTQ5ZTQtNDQzOS1iNDMwLWVlN2JkNGZiM2Y3OSIsInBob25lTnVtYmVyIjoiMjM0NzAzMzg3MjQzNSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwYXJ0bmVyQ29kZSI6Ijc5MDU5OCIsInNlY3JldEtleSI6IlhORUNLQVdGSVFMWFQ0RExEVjZFNDVMNVZNRUxLSk1FIiwibmFtZSI6ImtpbWJlcmxleSBPbW93ZWxlIiwicHJlZmVycmVkX3VzZXJuYW1lIjoia29tb3dlbGVAZ21haWwuY29tIiwiZ2l2ZW5fbmFtZSI6ImtpbWJlcmxleSIsImZhbWlseV9uYW1lIjoiT21vd2VsZSIsImVtYWlsIjoia29tb3dlbGVAZ21haWwuY29tIn0.C5tGLUHmGa73n1npmdwjY34z8N3qL8hYUlUB6vVJsIXs3KW_Nh_EvkJpBZuJJ6SFJ8eRCDdJDYiLcrx3OlbGDnGHNOb-8ihX3YlJc-Xm97h2YyaWh7OE8j48JTS4TP-qdZoulVnTylxNFMCATwbiQuKY24V2BQ1mD0Jbnw7VmeLZ57Y-8KfdXLuE9FxTVGQ7MAsjDinD5eekp6SpdMRVJ7SLNaJVUv4w9WLPxD2LHWQkkKz9VGavxs6Hgacf___jqlm_OgaAL6N17DojyQ1uLjDd4oKLbP0IHDBmzf7v2F-m36evqWYNqvUjqgd8mdbf0HdRP_jpw2wueT8WzN1m8A",
"emailVerified": true,
"refreshToken": "eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIzY2UxMDZiYS04ODIyLTQ0OWMtYWI1MS1iNjhiNTZlMGVlNzQifQ.eyJleHAiOjE3MzQ2NTk3MzEsImlhdCI6MTczNDYyMzczMSwianRpIjoiZDIwMTA0NmYtN2M5Ny00ODExLWE1OGItMzYwYjY4Y2U5ODRmIiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5tZ3QuY3NscGF5LmlvL3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJodHRwczovL2tleWNsb2FrLm1ndC5jc2xwYXkuaW8vcmVhbG1zL21hc3RlciIsInN1YiI6IjU1ZDBjNTBlLTRmYjYtNDU1My05ZTFkLWU2ZTZmMGRmMjcwZiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJhZG1pbi1jbGkiLCJzZXNzaW9uX3N0YXRlIjoiNTA3YzU5MzItNDllNC00NDM5LWI0MzAtZWU3YmQ0ZmIzZjc5Iiwic2NvcGUiOiJyb2xlcyBlbWFpbCBwcm9maWxlIiwic2lkIjoiNTA3YzU5MzItNDllNC00NDM5LWI0MzAtZWU3YmQ0ZmIzZjc5In0.-lmUpUM9sOSqpISmzP8h2Tsfg5jyibVsFJz5RWwpc3NLmJUfyCzu_bmcmqrskM8rFKHP2HSpzmbss-GgkAx40A",
"expiresIn": 36000,
"refreshExpiresIn": 36000
}
}What made this section unhelpful for you?
Possible Banks List
The Possible Banks List API is designed to accept an account number as input and return a list of banks to which the account number could potentially belong. This functionality helps in scenarios where the sender is uncertain about the recipient's bank or in cases where multiple banks may share similar account number patterns, enabling further validation before initiating a transaction.
Header Parameters
Path Parameters
Account Number to get Possible Bank List
Response
Response Attributes
What made this section unhelpful for you?
Base URL
Test Environment:
https://api.dev.cslpay.io
Response
[
{
"financialInstitutionCode": "058",
"financialInstitutionName": "GTB Nigeria",
"countryCode": "NGA"
}
]What made this section unhelpful for you?
Send Payout Request
This section allows users to initiate a payout request for remittance transactions. Users can specify transaction details, recipient and sender information, and additional channel information to send funds securely and efficiently. This functionality streamlines the process of sending payments to recipients and ensures accurate and timely processing.
Header Parameters
The authorization token used for authentication and access control.
Body Parameters
The list of transaction requests included in the remittance transaction.
Show child attributes
Response
Response Attributes
The batch id assigned to the transaction
The total count of transactions received
The count of transactions that returned with error
The date time the transaction was received
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"batchId": "73643f37-995d-4a06-a8a5-f188e1ec9146",
"totalCount": 1,
"errorTransactionCount": null,
"createDate": "2024-12-15 02:29:18"
}What made this section unhelpful for you?
List FX Rate
The List FX Rate section allows users to retrieve a list of foreign exchange rates for different countries. By accessing this section, users can obtain up-to-date FX rates to facilitate accurate currency conversion in their transactions or financial operations.
Header Parameters
The Authorization header parameter is used to provide authentication credentials to access the FX rate API.
Query Parameters
The countryCode query parameter is used to specify the country code for which the FX rate is requested.
Response
Response Attributes
What made this section unhelpful for you?
Response
{
"countryCode": "NGA",
"countryName": "Nigeria",
"fxDealRate": 1240,
"fxWindow": "FIXED DURATION"
}What made this section unhelpful for you?
IMTO Admin List Balances
The IMTO Admin List Balances section provides a comprehensive overview of the balances associated with specific IMTO admin accounts. Users can retrieve detailed information on the current balances, enabling them to effectively manage and monitor their financial resources within the platform. This section offers valuable insights for decision-making and financial planning.
Header Parameters
The accept header parameter specifies the media types that are acceptable for the response. This parameter helps the client indicate its preferred media type for the returned data.
The Authorization header parameter is used to provide the API with the necessary credentials for authentication and authorization purposes.
Response
Response Attributes
Currency Code
Currency Balance
What made this section unhelpful for you?
Response
[
{
"currencyCode": "NGN",
"totalBalance": 43899490.5
},
{
"currencyCode": "GHS",
"totalBalance": 577979984
},
{
"currencyCode": "SLL",
"totalBalance": 1050000
}
]What made this section unhelpful for you?
List Financial Institutions
The List Financial Institutions section provides users with the ability to retrieve a comprehensive list of supported financial institutions within the remittance middleware system. This allows users to easily access and select the appropriate financial institution for processing payouts, streamlining the payout process and ensuring accurate and efficient transactions.
Header Parameters
The Authorization header parameter contains the authentication credentials required for accessing the list of financial institutions. It is necessary to include this parameter in the request headers to authenticate and authorize the API call.
Response
Response Attributes
Show child attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
[
{
"status": true,
"financialInstitutionCode": "059",
"financialInstitutionName": "Guaranty Trust Bank",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "098",
"financialInstitutionName": "Wema",
"countryCode": {
"countryCode": "GHA",
"countryName": "Ghana",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "044",
"financialInstitutionName": "Access Bank",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "033",
"financialInstitutionName": "United Bank Of Africa",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "MTN",
"financialInstitutionName": "MTN Ghana",
"countryCode": {
"countryCode": "GHA",
"countryName": "Ghana",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "ABSA",
"financialInstitutionName": "ABSA Ghana",
"countryCode": {
"countryCode": "GHA",
"countryName": "Ghana",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": false,
"financialInstitutionCode": "057",
"financialInstitutionName": "Zenith Bank",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "058",
"financialInstitutionName": "GTB Nigeria",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "305",
"financialInstitutionName": "OPAY",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"status": true,
"financialInstitutionCode": "011",
"financialInstitutionName": "FIRST BANK",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
},
{
"institutionCode": "000014",
"status": true,
"financialInstitutionCode": "063",
"financialInstitutionName": "ACCESS",
"countryCode": {
"countryCode": "NGA",
"countryName": "Nigeria",
"status": false,
"isSenderCountry": true,
"isReceiverCountry": true
}
}
]What made this section unhelpful for you?
Refresh Token
The Refresh Token section allows users to obtain a new access token without needing to re-enter their credentials. By utilizing this functionality, users can seamlessly maintain authorized access to the system and extend the validity of their authentication tokens.
Header Parameters
The Authorization header parameter is used to authenticate the client's request to refresh the token. It must contain the client's access token in the format "Bearer {access_token}".
Body Parameters
The refresh token gotten from the previous login
Response
Response Attributes
What made this section unhelpful for you?
Response
{
"token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJoTkc3SmotWjRSX1dtNTEtcGpJWDlWTlBsNlljLUwxNHhZNzB0NDNBQkJ3In0.eyJleHAiOjE3MzQ2NTk3MzEsImlhdCI6MTczNDYzMDkzMCwianRpIjoiMWRkMjI4N2YtM2Y5NC00NmEwLThkNzQtNGQwNzk3YjU2NTg1IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5tZ3QuY3NscGF5LmlvL3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJhY2NvdW50Iiwic3ViIjoiNTVkMGM1MGUtNGZiNi00NTUzLTllMWQtZTZlNmYwZGYyNzBmIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoiYWRtaW4tY2xpIiwic2Vzc2lvbl9zdGF0ZSI6IjUwN2M1OTMyLTQ5ZTQtNDQzOS1iNDMwLWVlN2JkNGZiM2Y3OSIsImFjciI6IjEiLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsiZGVmYXVsdC1yb2xlcy1tYXN0ZXIiLCJvZmZsaW5lX2FjY2VzcyIsInVtYV9hdXRob3JpemF0aW9uIiwiaW10by1hZG1pbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoicm9sZXMgZW1haWwgcHJvZmlsZSIsInNpZCI6IjUwN2M1OTMyLTQ5ZTQtNDQzOS1iNDMwLWVlN2JkNGZiM2Y3OSIsInBob25lTnVtYmVyIjoiMjM0NzAzMzg3MjQzNSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJwYXJ0bmVyQ29kZSI6Ijc5MDU5OCIsInNlY3JldEtleSI6IlhORUNLQVdGSVFMWFQ0RExEVjZFNDVMNVZNRUxLSk1FIiwibmFtZSI6ImtpbWJlcmxleSBPbW93ZWxlIiwicHJlZmVycmVkX3VzZXJuYW1lIjoia29tb3dlbGVAZ21haWwuY29tIiwiZ2l2ZW5fbmFtZSI6ImtpbWJlcmxleSIsImZhbWlseV9uYW1lIjoiT21vd2VsZSIsImVtYWlsIjoia29tb3dlbGVAZ21haWwuY29tIn0.e4wHHqJmiedefMcTssqcz0y5G9UzItiuEPXp-5Ske9dZX9nPx_2TqLJh4zOH4t0-eRoYYnR3xk2u-nsk8UXPjFXWVtfPcnmG6e42bipeddmrkob7r0ZFtfhyS3xrfavqQMFjp9puM4vaxSEIc9uJsqqRtiPqj6vTQdlB9vtyNLo5SbFzO88mFrxRLoQsKbT3IBGIcWCVl1bH3EpJBEMhwrPWwlBFAjc9rJh_NVNShnDrz94Y4KGtZ50NLiwciVN9J2udkax2R63eVRG_mtLAySzcza2cILEE_aFJOP5yJeFIWO67zdSaJG7Uu5zPNt7tDk-znzzPFFTx-kEqpvKkMQ",
"expiresIn": 28801,
"refreshExpiresIn": 28801,
"refreshToken": "eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIzY2UxMDZiYS04ODIyLTQ0OWMtYWI1MS1iNjhiNTZlMGVlNzQifQ.eyJleHAiOjE3MzQ2NTk3MzEsImlhdCI6MTczNDYzMDkzMCwianRpIjoiNTlkYjIwMjctOWY3My00NjczLWI1MDUtNzQ0YTZiOWZiZWY3IiwiaXNzIjoiaHR0cHM6Ly9rZXljbG9hay5tZ3QuY3NscGF5LmlvL3JlYWxtcy9tYXN0ZXIiLCJhdWQiOiJodHRwczovL2tleWNsb2FrLm1ndC5jc2xwYXkuaW8vcmVhbG1zL21hc3RlciIsInN1YiI6IjU1ZDBjNTBlLTRmYjYtNDU1My05ZTFkLWU2ZTZmMGRmMjcwZiIsInR5cCI6IlJlZnJlc2giLCJhenAiOiJhZG1pbi1jbGkiLCJzZXNzaW9uX3N0YXRlIjoiNTA3YzU5MzItNDllNC00NDM5LWI0MzAtZWU3YmQ0ZmIzZjc5Iiwic2NvcGUiOiJyb2xlcyBlbWFpbCBwcm9maWxlIiwic2lkIjoiNTA3YzU5MzItNDllNC00NDM5LWI0MzAtZWU3YmQ0ZmIzZjc5In0.nPWfIxhqX3VeUgY0SA98CbMHaFxapjUxMaZAgINsCEjcBZFZU7yINppMy04uC8pwb7kMBaznvy0bVwE3qGkFqA",
"tokenType": "Bearer"
}What made this section unhelpful for you?
Account Enquiry
The Account Enquiry section allows users to verify the status and details of a specific bank account associated with their account. By querying this endpoint, users can retrieve important information such as the account's current balance, transaction history, and account holder details. This functionality helps streamline financial processes and ensures accurate and secure transactions.
Header Parameters
Indicates the media type that is acceptable in the response for the account enquiry.
Specifies the media type of the request being sent to the server for the account enquiry.
A security token that grants access to make an account enquiry via the gateway.
Body Parameters
The specific account number for which the enquiry is being made.
The unique code assigned to the bank for which the account enquiry is being made.
Response
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"accountNumber": "0106456890",
"bankCode": "059",
"accountName": "Customer Name",
"responseCode": "00",
"currencyCode": "NGN",
"responseDescription": "Account resolve successful"
}What made this section unhelpful for you?
Transaction Status
The Transaction Status section of the Payout API Documentation allows users to check the status of a specific transaction. By querying this endpoint, users can obtain real-time updates on the progress and outcome of their transactions, enabling them to track and manage their payouts effectively.
Header Parameters
This header parameter is used to authenticate the request to check the status of a transaction in the remittance middleware. It must contain a valid authorization token for access to the specified endpoint.
Path Parameters
The unique identifier of the transaction for which the status is being checked in the remittance middleware.
Response
Response Attributes
Response Attributes
Show child attributes
What made this section unhelpful for you?
Response
{
"transactionReference": "790598202412054567654576987814",
"responseCode": "00",
"responseMessage": "Payout processed successfully",
"processorResponseCode": "true",
"processorTransactionReference": "21d1ca87d9ce4f37",
"processorResponseTime": "2024-12-05 12:08:52",
"processorResponseDescription": "Payout processed successfully"
}What made this section unhelpful for you?
Webhook
To provide real-time feedback on the outcome of payout transactions, we support sending responses to a Webhook URL provided by the IMTO Partner. This mechanism ensures that IMTO Partners are promptly notified of transaction statuses, enabling seamless integration with their systems.
{
"transactionReference": "790598202412054567654576987814",
"responseCode": "00",
"responseMessage": "Payout processed successfully",
"processorResponseCode": "true",
"processorTransactionReference": "21d1ca87d9ce4f37",
"processorResponseTime": "2024-12-05 12:08:52",
"processorResponseDescription": "Payout processed successfully"
}What made this section unhelpful for you?
Response Codes
The Response Codes section provides detailed information on the various responses that may be returned when interacting with the API. By understanding these response codes, users can troubleshoot issues more effectively and implement proper error handling in their applications. This section serves as a valuable resource for developers looking to ensure the reliability and stability of their integration with the Default API.
To provide real-time feedback on the outcome of payout transactions, we support sending responses to a Webhook URL provided by the IMTO Partner. This mechanism ensures that IMTO Partners are promptly notified of transaction statuses, enabling seamless integration with their systems.
RESPONSE CODE | DESCRIPTION | ACTION REQUIRED |
00 | PAID or SUCCESSFULLY COMPLETED | No Action. Operation was completed successfully |
01 | AWAITING RESPONSE FROM BANK | No Action. We will send a notification once response is received |
02 | PROCESSING | Requery with transaction Id for final status. We will send a notification once we receive a response |
10 | FLAGGED TRANSACTION | Action Required. The transaction has been flagged by the fraud system. This could be due to limit exceeded for payout to that account or a blacklisted account. Log in to the portal and approve or decline the transaction |
20 | INSUFFICIENT FUNDS | Action Required. Reach out to the treasury team to fund your account. Resend the transaction with a new transaction reference |
40 | INVALID ACCOUNT NUMBER | Action Required. The recipient account number is not valid. Validate that the account number is correct and resend the transaction with a new transaction reference |
50 | REJECTED | Action Required. The rejection reason is sent in the response to your webhook. Once the issue has been identified and fixed, resend the transaction with a new transaction reference |
51 | TRANSACTION FAILED | No Action Required. |
60 | SYSTEM ERROR | No Action Required. Please contact CSL Pay Support Team |
80 | UNAUTHORIZED | No Action Required. Please contact CSL Pay Support Team |
90 | INVALID TRANSACTION | No Action Required. Please contact CSL Pay Support Team |