Sign in

Create a new account under an existing account holder.

This endpoint is used to create an account under an existing account holder. An account holder may 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_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 required

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 required

Indicates whether the request is processed synchronously or asynchronously. Depending on the request's platform settings, the following scenarios may be applied:

  • sync: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.
  • async: The request is queued and will be executed when the providing service is available in the order in which the requests are received.
  • asyncOnError: The processing of the request is immediately attempted, but if the providing service is unavailable, the request is scheduled in a queue.

Changes