This API enables you to receive a list of all available payin methods. The app-id and secret-key will be used to determine the necessary payin methods based on the country and currency. You can configure this information in the Hello Clever Merchant Dashboard.

Certain payment methods may require information to be collected from consumers. This API will provide all parameters potentially needed for a specific payin method. The returned parameters may be either optional or mandatory.

To be able to successfully create a payin request you would need the following APIs in consideration:

• Step 1: Call the Get payin methods to retrieve the list of supported methods.
• Step 2: Call the Get payin required fields to get specific required fields for each method.
• Step 3: Create the payment using the method and required fields from the previous step.
• Step 4: On sandbox environment, you can call the Simulate payin to simulate the payment.

Note:
If the payin_method_name is jp_bank_jpy, the pay_code will be sent to the webhook after a certain period with the following fields:

• bank_name: The recipient's bank name.
• transfer_id: The transfer identifier on the provider side.
• branch_code: The code of the recipient's bank branch.
• branch_name: The name of the recipient's bank branch.
• account_number: The recipient's account number.
• account_name: The recipient's account name.
• expired_timestamp: The payment expiration time.
• account_type: The recipient's account type.
• transfer_name: The name associated with the transfer.

If you use one of the following payin methods, please check the list of supported providers before proceeding:

• sa_eft_zar: View supported
• my_bank_fpx_myr: View supported

❗ Important:
For Step 3, if you choose mobile_money as the payin method, as the PayIn method, refer to the instructions in the Mobile Money tab.

• For example: gh_mobile_money_ghs

This API allows you to fetch a complete list of payin linked to your app-id. You can filter the results based on multiple query params. This API is paginated. The default is 20 transactions per page.

This API allows you to fetch the details of a specific payin request. You can use the UUID to retrieve the details of a specific payment request.

This API allows you to simulate a payin request completion. This is useful for testing purposes and works only in sandbox environment. To complete the payment, it must be in a PENDING status.

Initiate a refund request on a completed payin (with received status). Before initiating the refund, check if the payin method is refundable (is_refundable == true).

Cancel a pending Payin transaction,the transaction status will be updated to expired. Before cancel payin, check if the payin method is cancellable (is_cancellable == true).

After submitting a request to Create a PayIn Request using the mobile_money PayIn method, if the stage field is authorize_otp, it means an OTP has been sent to the wallet owner's phone. You should collect the OTP to authorize the Payin. Retrieve the OTP sent to the customer's phone and send a request to our authorization endpoint. If the OTP verification is successful, an STK prompt will be sent to the wallet owner's phone, prompting them to enter their PIN.

This endpoint allows you to resend OTP in a situation where the initial OTP received had expired or was not received at all.

This endpoint allows you to authorize the transaction in the Sandbox environment. It is meant to simulate a wallet owner entering their wallet PIN at the STK prompt.

This endpoint allows you to resend the STK prompt in a situation where the initial STK prompt received had expired or was not received at all.

This API enables you to receive a list of all available payout methods. The app-id and secret-key will be used to determine the necessary payout methods based on the country and currency. You can configure this information in the Hello Clever Merchant Dashboard.

Certain payout methods may require information to be collected from consumers. This API will provide all the parameters potentially needed for a specific payout method. The returned parameters could be either optional or mandatory.

This API enables outbound payments in mutilple currency using supported payout methods. Steps to create a payout:

• Step 1: Call the Get payout methods to retrieve the list of supported methods.
• Step 2: Call the Get payout required fields to get specific required fields for each method.
• Step 3: Initialize a payout with the required fields.

You only need to do steps 1 and 2 once. After that, you can use the same method and required fields to create a payout payment.

There are 4 statuses of the payment:

• created: Payout payment created.
• processing: Payout has been processed
• scheduled: Waiting for fund to be charged to the payee.
• completed: Payout payment has been completed for the entire batch, not for individual transactions.

Please note: If you use one of the following payout methods, please check the list of supported providers before proceeding:

• ph_bank_php: View supported
• id_bank_idr: View supported
• ng_bank_ngn: View supported
• sa_bank_zar: View supported
• ke_bank_kes: View supported
• ke_mobile_money_kes: View supported
• gh_mobile_money_ghs: View supported
• cm_mobile_money_xaf: View supported
• ci_mobile_money_xof: View supported
• ci_mobile_money_xof: View supported
• my_bank_myr: View supported
• my_ewallet_*_myr (touchngo, finexus, boost, bigpay, shopee, gxbank, merchantrade): View supported

Please note that if any of the transactions fail, it will not affect the completion of the entire batch.

You can easily query payout payments in a period of time. Currently we support up to 1 year period. Should you need more, please contact us directly.

Check the status of a payout payment. There are 4 statuses:

• created: Payout payment created.
• processing: Payout has been topup to payID response.
• scheduled: Waiting charge fund to payee.
• completed: Payout payment completed.

This API works only in sandbox environment and allows you to simulate the completion of a payment. To complete the payout, it must be in a PENDING status.

You can cancel a payout payment scheduled to run in the future.

When processing a Payin or Payout transaction, if the require_contact parameter is true, you need to create a new contact before proceeding with the transaction. Each contact will have a unique email associated with it, ensuring that the user’s information is complete before continuing with the payment process. This email will be used during the process of calling the API to create a Payin or Payout transaction.

After successfully creating the contact, you need to perform KYC (Know Your Customer) verification for this contact if the Payin or Payout methods require KYC(require_kyc == true). This will be done through the Submit KYC API provided below. If KYC is not required, you can proceed with the transaction process without further verification. Ensure that these steps are completed thoroughly and accurately to maintain security and compliance. Wishing you success in carrying out this process!

This API allows you to submit the necessary KYC documents for a specific contact. The KYC documents include the contact's identity proof (e.g., ID card, passport), a selfie, and relevant document images. You must provide the correct contact email.

The following parameters are required for the successful submission of KYC:

• email: The contact's email used for verification.
• document_type: Type of identification document (e.g., passport, ID card,...).
• document_number: The identification number on the document.
• document_username: The name as shown on the identification document.
• issue_date: The date the identification document was issued.
• expiry_date: The expiry date of the identification document.
• issue_country: The country that issued the identification document.
• nationality: The country of nationality of the contact (ISO 3166-1 alpha-2 code).
• selfie:A selfie image of the contact for identity verification should be in JPEG format.
• id_doc_front_side:The front side image of the identification document should be in JPEG or PNG format.
• id_doc_back_side: The back side image of the identification document should be in JPEG or PNG format
• webhook_notification: A JSON object containing the endpoint_url and authorization_header for receiving KYC status change notifications.

Contact Hello Clever Support team to get Sumsub Client ID.

See the Sumsub Authentication documentation (https://docs.sumsub.com/reference/authentication) to add the required headers to the Sumsub API request.

This API enables merchants to verify a contact’s identity seamlessly using Sumsub KYC solution. Instead of requiring contacts to upload identification documents and selfies directly, this API leverages a token-based approach. When a contact completes their KYC process through Sumsub interface, a unique verification token is generated. This token represents the validated identity data, eliminating the need for manual document handling. The merchant submits this token along with the contact’s email to finalize the verification process on the server. Additionally, this API allows for automated KYC status tracking through webhook notifications. Merchants can provide a callback URL and an authorization header to receive real-time updates whenever the KYC status changes, ensuring a smooth verification experience without requiring periodic checks. With this approach, merchants can enhance security, streamline identity verification, and provide contacts with a frictionless onboarding experience.