Payout Management API

danger

This part have released for public.

Transactions made through Wonder Gateway will be automatically settled into your Wonder App. Via the Wonder App, you can directly make payments to your employees or suppliers. Now we have launched the Payout Management API, which allows you to initiate transfers via API and integrate with your financial software.

• Payee Management API: Manage payee accounts via API.
• Payout Reqeust Management API: Create a payout transfer request via API.

Payee Management API

field	data_type	example	comment
type	string	Company	Supports Company / People
nickname	string	XXX Company	display on wonder app
email	string	aa@bb.com	for personal account
phone_country_code	string	+852	-
phone_number	string		-
payout_account.country	string	HK	the payee account country
payout_account.currency	string	HKD	payee account currency
payout_account.transfer_method	string	Supports HK FPS - Account Number / HK FPS - Mobile / HK FPS - Email / HK FPS- FPS ID
payout_account.hk_fps	object	-	for FPS transfer method
payout_account.hk_fps.bank_account	object	-	for HK FPS - Account Number
payout_account.hk_fps.bank_account.bank_code	string	004	the payee HK bank code
payout_account.hk_fps.bank_account.account_name	string	-	the payee bank account name
payout_account.hk_fps.bank_account.account_number	string	-	the payee bank account number
payout_account.hk_fps.email	string	-	for HK FPS - Email, the payee FPS account email
payout_account.hk_fps.email	string	-	for HK FPS - Mobile, the payee FPS account mobile
payout_account.hk_fps.fps_id	string	-	for HK FPS - FPS ID, the payee FPS account id

POST

Create Payee

>

GET

GET Payee

>

DELETE

Delete Payee

>

---

Payout Request Management API

field	data_type	example	comment
payee_id	string	-	from Create Payee API
reference_id	string	-	your side unique payment transaction id
currency	string	HKD	deduct from which wonder business wallet
amount	string	100.00	the transfer amount
scheduled_at	datetime	2025-01-01T00:00:00Z	scheduled payout, it's should be UTC timezone
remark	string	-	the remark will send to the payee bank
callback_url	string	-	which backend server receive this payout request callback

POST

Create Payout Request

>

PUT

Cancel Payout Request

>

GET

GET Payout Request

>

---

Webhook

Action Name	Comment
payout_request.created	when a payout_request created
payout_request.settled	when a payout_request completed
payout_request.reversed	when a payout_request reversed by manual or system
payout_requests.refunded	successful send payout to the payee account,but the payee bank rejected

Reqeust Body

{
    "id" : "",
    "payee_id" : "",
    "transfer_method" : "",
    "currency" : "",
    "amount" : "",
    "remark" : "",
    "p_created_at" : "",
    "p_updated_at" : "",
    "processed_at" : "",
    "settled_at" : "",
    "reversed_at" : ""
}