Create a Payout
POST/v2/payouts
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 processedscheduled: 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 supportedid_bank_idr: View supportedng_bank_ngn: View supportedsa_bank_zar: View supportedke_bank_kes: View supportedke_mobile_money_kes: View supportedgh_mobile_money_ghs: View supportedcm_mobile_money_xaf: View supportedci_mobile_money_xof: View supportedmy_bank_myr: View supportedmy_ewallet_*_myr(touchngo,finexus,boost,bigpay,shopee,gxbank,merchantrade): View supportedbr_bank_brl: View supportedth_bank_thb: View supported
Please note that if any of the transactions fail, it will not affect the completion of the entire batch.
Request
Responses
- 200
- 401
- 404
- 422
OK
Unauthorized
Not Found
Unporcessable Entity
Callbacks
- POST myEvent
POST{$request.body#/webhook_notification/endpoint_url}
If the merchant specifies values for the webhook_notification object during the Create a Payout invocation, then a notification will be sent to the merchant system when it's status has changed.
The event will use webhook_notification.endpoint_url as endpoint and webhook_notification.authorization_header as Authorization header. We strongly recommend to use a different value for authorization_header on each payment request to increase the level of security.
This call is made by Hello Clever on a best effort basis. Hello Clever will implement retry mechanisms to ensure transient network failures do not affect the ability to call this endpoint. Hello Clever may call this endpoint more than once with the same payload so the merchant must ensure that the endpoint is implemented with idempotent behaviour always returning a 200 OK response even after subsequent calls.
If the target endpoint does not return HTTP 200, Hello Clever will retry the webhook call 3 times with 15 minutes delay per call.