Sign in

v1

latestOpenAPI 3.1.02026-07-201774202.6 KB
Accounts

Create an 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' | 'DAILY' | 'DAILY_AU' | 'DAILY_EU' | 'DAILY_SG' | 'DAILY_US' | 'HOLD' | 'MONTHLY' | 'WEEKLY' | 'WEEKLY_MON_TO_FRI_AU' | 'WEEKLY_MON_TO_FRI_EU' | 'WEEKLY_MON_TO_FRI_US' | 'WEEKLY_ON_TUE_FRI_MIDNIGHT' | 'WEEKLY_SUN_TO_THU_AU' | 'WEEKLY_SUN_TO_THU_US'

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.

payoutScheduleReasonstring

The reason for the payout schedule choice.

This field is required when the payoutSchedule parameter is set to HOLD.

Response

OK - the request has succeeded.

accountCodestring

The code of the new account.

accountHolderCodestring

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'

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.