User Login

Possible Banks List

Send Payout Request

List FX Rate

IMTO Admin List Balances

List Financial Institutions

Refresh Token

Account Enquiry

Transaction Status

Webhook

Response Codes

Default

Payout API Documentation

Test Environment

Sandbox

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

The email address associated with the user account for logging in.

email

The password for the user account for authentication during login.

password

status

data

<p class="slate-p " >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&apos;s bank or in cases where multiple banks may share similar account number patterns, enabling further validation before initiating a transaction.</p><p class="slate-p " ></p>

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.

Authorization

accountNumber

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

The list of transaction requests included in the remittance transaction.

transactionRequestList

The authorization token used for authentication and access control.

batchId

totalCount

The count of transactions that returned with error

errorTransactionCount

The date time the transaction was received

createDate

type

title

instance

timestamp

transactionResponse

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

The Authorization header parameter is used to provide authentication credentials to access the FX rate API.

The countryCode query parameter is used to specify the country code for which the FX rate is requested.

countryCode

countryName

fxDealRate

fxWindow

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

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.

accept

The Authorization header parameter is used to provide the API with the necessary credentials for authentication and authorization purposes.

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

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.

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

The refresh token gotten from the previous login

refreshToken

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}".

token

expiresIn

refreshExpiresIn

tokenType

<p class="slate-p " >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&apos;s current balance, transaction history, and account holder details. This functionality helps streamline financial processes and ensures accurate and secure transactions.</p><p class="slate-p " ></p>

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.

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.

bankCode

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.

Content-Type

A security token that grants access to make an account enquiry via the gateway.

accountName

responseCode

currencyCode

responseDescription

detail

properties

<p class="slate-p " >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.</p><p class="slate-p " ></p>

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.

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.

The unique identifier of the transaction for which the status is being checked in the remittance middleware.

transactionReference

responseMessage

processorResponseCode

processorTransactionReference

processorResponseTime

processorResponseDescription

<p class="slate-p " >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.</p><p class="slate-p " ><p class="slate-p " ></p></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line">{
    &quot;transactionReference&quot;: &quot;790598202412054567654576987814&quot;,
    &quot;responseCode&quot;: &quot;00&quot;,
    &quot;responseMessage&quot;: &quot;Payout processed successfully&quot;,
    &quot;processorResponseCode&quot;: &quot;true&quot;,
    &quot;processorTransactionReference&quot;: &quot;21d1ca87d9ce4f37&quot;,
    &quot;processorResponseTime&quot;: &quot;2024-12-05 12:08:52&quot;,
    &quot;processorResponseDescription&quot;: &quot;Payout processed successfully&quot;
}</div></code></pre></div><p class="slate-p " ></p>

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.

<p class="slate-p " >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.</p><p class="slate-p " >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.</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:194px;">Title</div><div style="width:492px;">Description</div><div style="width:0px;">Title</div></div><colgroup ><col style="width:194px"><col style="width:492px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">RESPONSE CODE</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">DESCRIPTION</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">ACTION REQUIRED</strong></p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >00</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PAID or SUCCESSFULLY COMPLETED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action. Operation was completed successfully</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >01</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >AWAITING RESPONSE FROM BANK</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action. We will send a notification once response is received</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >02</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PROCESSING</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Requery with transaction Id for final status. We will send a notification once we receive a response</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >10</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >FLAGGED TRANSACTION</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >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</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >20</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INSUFFICIENT FUNDS</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Action Required. Reach out to the treasury team to fund your account. Resend the transaction with a new transaction reference</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >40</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INVALID ACCOUNT NUMBER</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >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</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >50</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >REJECTED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >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</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >51</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TRANSACTION FAILED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action Required. </p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >60</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >SYSTEM ERROR</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action Required. Please contact CSL Pay Support Team</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >80</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >UNAUTHORIZED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action Required. Please contact CSL Pay Support Team</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >90</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INVALID TRANSACTION</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >No Action Required. Please contact CSL Pay Support Team</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

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.

Sections