Create a new account.
Creates an account under an account holder. An account holder can have multiple accounts.
post/createAccount
Request body
accountHolderCodestring required
The code of Account Holder under which to create the account.
payoutSchedule'BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT' | 'BIWEEKLY_ON_1ST_AND_15TH_AT_NOON' | 'DAILY' | 'DAILY_6PM' | 'DAILY_AU' | 'DAILY_EU' | 'DAILY_SG' | 'DAILY_US' | 'DEFAULT' | 'EVERY_6_HOURS_FROM_MIDNIGHT' | 'HOLD' | 'MONTHLY' | 'WEEKLY' | 'WEEKLY_ON_TUE_FRI_MIDNIGHT' | 'YEARLY'
The payout schedule of the prospective account.
Permitted values: DEFAULT, HOLD, DAILY, WEEKLY, MONTHLY.
payoutScheduleReasonstring
The reason for the payout schedule choice.
Required if the payoutSchedule is HOLD.
Response
OK - the request has succeeded.
accountCodestring required
The code of the new account.
accountHolderCodestring required
The code of the account holder.
pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
status'Active' | 'Closed' | 'Inactive' | 'Suspended' required
The status of the account.
Permitted values: Active.
submittedAsyncboolean
Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied:
- true: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
- false: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.