ADadyen
Accounts

Create an account

Changed on

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

post/createAccount

Request

  • Base URL
    https://cal-test.adyen.com/cal/services/Account/v5
  • URL
    https://cal-test.adyen.com/cal/services/Account/v5/createAccount
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Request body

accountHolderCodestring required

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

bankAccountUUIDstring

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.

descriptionstring

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

metadataobject

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.

payoutMethodCodestring

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.

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.

payoutSpeed'INSTANT' | 'SAME_DAY' | 'STANDARD'

Speed at which payouts for this account are processed.

Possible values: STANDARD (default), SAME_DAY.

Response

OK - the request has succeeded.

accountCodestring

The code of the new account.

accountHolderCodestring

The code of the account holder.

bankAccountUUIDstring

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.

descriptionstring

The description of the account.

metadataobject

A set of key and value pairs containing metadata.

payoutMethodCodestring

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'INSTANT' | 'SAME_DAY' | 'STANDARD'

Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.

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.

Changes

  • v5a94da11458a5Revision changes
    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

    • warning

      added the new linkedViasVirtualAccount enum value to the /// response property for the response status

  • v501d8bf3d997bRevision changes
    • warning

      added the new payoutMethod enum value to the /// response property for the response status

    • warning

      added the new payoutMethod enum value to the /// response property for the response status