Create an account
Creates an account under an account holder. An account holder can have multiple accounts.
Request body
The code of Account Holder under which to create the account.
The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.
A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.
A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired.
Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.
The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.
The payout schedule for the account.
Possible values: DEFAULT, DAILY, DAILY_US, DAILY_EU, DAILY_AU, DAILY_SG, WEEKLY, WEEKLY_ON_TUE_FRI_MIDNIGHT, BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT, MONTHLY, HOLD.
HOLD prevents scheduled payouts, but you can still initiate payouts manually.
The reason for the payout schedule choice.
This field is required when the payoutSchedule parameter is set to HOLD.
Speed at which payouts for this account are processed.
Possible values: STANDARD (default), SAME_DAY.
Response
OK - the request has succeeded.
The code of the new account.
The code of the account holder.
The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.
The description of the account.
A set of key and value pairs containing metadata.
The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
The reference of a request. Can be used to uniquely identify the request.
The result code.
The status of the account.
Permitted values: Active.