Skip to main content

Create payee

POST 

/api/v1/openapi/payees

Create a Payee and its PayoutAccount.

Conditional field matrix

transfer_methodRequired block
HK FPS - Account Numberpayee.payout_account.hk_fps.bank_account (bank_code / account_name / account_number)
HK FPS - Mobilehk_fps.mobile + hk_fps.full_name
HK FPS - Emailhk_fps.email + hk_fps.full_name
HK FPS - FPS IDhk_fps.fps_id + hk_fps.full_name
RTGSrtgs.bank_account (swift_code / account_name / account_number)
SWIFTswift.bank_account (swift_code / account_name / account_number)

date_of_birth condition

When payee.type = People and transfer_method is one of the HK FPS methods below, payout_account.date_of_birth is required:

  • HK FPS - Account Number
  • HK FPS - Mobile
  • HK FPS - Email
  • HK FPS - FPS ID

Format: YYYY-MM-DD.

Request

Responses

Created successfully

Response Headers