Create an account

post/createAccount

API Version

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

Endpoint destination URL

https://cal-test.adyen.com/cal/services/Account/v4/createAccount

Request Parameters

Required

Optional

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

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

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.

The reason for the payout schedule choice.

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

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
accountCodestring
The code of the new account.
accountHolderCodestring
The code of the account holder.
descriptionstring
The description of the account.
payoutScheduleobject
The details of the payout schedule added to the account.
nextScheduledPayoutstring
The date of the next scheduled payout.
schedulestring
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.

pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
statusstring
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.
202 - Accepted
The request has been accepted for processing, but the processing has not been completed.
accountCodestring
The code of the new account.
accountHolderCodestring
The code of the account holder.
descriptionstring
The description of the account.
payoutScheduleobject
The details of the payout schedule added to the account.
nextScheduledPayoutstring
The date of the next scheduled payout.
schedulestring
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.

pspReferencestring
The reference of a request. Can be used to uniquely identify the request.
resultCodestring
The result code.
statusstring
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.
400 - Bad Request
A problem reading or understanding the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
401 - Unauthorized
Authentication required.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
403 - Forbidden
Insufficient permissions to process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
422 - Unprocessable Entity
A request validation error.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.
500 - Internal Server Error
The server could not process the request.
errorCodestring
The error code mapped to the error message.
errorTypestring
The category of the error.
messagestring
A short explanation of the issue.
pspReferencestring
The PSP reference of the payment.
statusinteger
The HTTP response status.

Create an account

HTTP Responses

200 - OK

202 - Accepted

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error