POST /createAccount

Creates an account under an account holder. An account holder can have multiple accounts.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
payoutSchedule String No

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.

Possible values:

  • "HOLD"
  • "DAILY_AU"
  • "DAILY_SG"
  • "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT"
  • "WEEKLY_MON_TO_FRI_AU"
  • "WEEKLY_ON_TUE_FRI_MIDNIGHT"
  • "WEEKLY_MON_TO_FRI_EU"
  • "WEEKLY"
  • "DAILY_EU"
  • "MONTHLY"
  • "WEEKLY_SUN_TO_THU_AU"
  • "DAILY"
  • "DAILY_US"
  • "WEEKLY_MON_TO_FRI_US"
  • "WEEKLY_SUN_TO_THU_US"
description String No

A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.

payoutMethodCode String No

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.

payoutSpeed String No

Speed at which payouts for this account are processed.

Possible values: STANDARD (default), SAME_DAY.

Possible values:

  • "INSTANT"
  • "SAME_DAY"
  • "STANDARD"

Default value: "STANDARD"

metadata Object No

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.

payoutScheduleReason String No

The reason for the payout schedule choice.

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

bankAccountUUID String No

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.

accountHolderCode String Yes

The code of Account Holder under which to create the account.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.