Adyen for Platforms: Account API
  1. Accounts
Adyen for Platforms: Account API
  • Verification
    • Trigger verification
      POST
    • Delete bank accounts
      POST
    • Delete legal arrangements
      POST
    • Delete payout methods
      POST
    • Delete shareholders
      POST
    • Delete signatories
      POST
    • Get documents
      POST
    • Upload a document
      POST
  • Accounts
    • Close an account
      POST
    • Create an account
      POST
    • Update an account
      POST
  • Account holders
    • Close an account holder
      POST
    • Close stores
      POST
    • Create an account holder
      POST
    • Get an account holder
      POST
    • Get a tax form
      POST
    • Suspend an account holder
      POST
    • Unsuspend an account holder
      POST
    • Update an account holder
      POST
    • Update payout or processing state
      POST
  1. Accounts

Create an account

POST
/createAccount
Accounts
Creates an account under an account holder. An account holder can have multiple accounts.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/createAccount' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountHolderCode": "string",
    "bankAccountUUID": "string",
    "description": "string",
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "payoutMethodCode": "string",
    "payoutSchedule": "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
    "payoutScheduleReason": "string",
    "payoutSpeed": "STANDARD"
}'
Response Response Example
200 - Example 1
{
  "accountCode": "string",
  "accountHolderCode": "string",
  "bankAccountUUID": "string",
  "description": "string",
  "invalidFields": [
    {
      "errorCode": 0,
      "errorDescription": "string",
      "fieldType": {
        "field": "string",
        "fieldName": "accountCode",
        "shareholderCode": "string"
      }
    }
  ],
  "metadata": {
    "property1": "string",
    "property2": "string"
  },
  "payoutMethodCode": "string",
  "payoutSchedule": {
    "nextScheduledPayout": "2019-08-24T14:15:22Z",
    "schedule": "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT"
  },
  "payoutSpeed": "INSTANT",
  "pspReference": "string",
  "resultCode": "string",
  "status": "Active"
}

Request

Body Params application/json
accountHolderCode
string 
required
The code of Account Holder under which to create the account.
bankAccountUUID
string 
optional
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.
description
string 
optional
A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores _.
metadata
object 
optional
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.
Additional properties
string 
optional
payoutMethodCode
string 
optional
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
enum<string> 
optional
The payout schedule of the prospective account.
Permitted values: DEFAULT, HOLD, DAILY, WEEKLY, MONTHLY.
Allowed values:
BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHTDAILYDAILY_AUDAILY_EUDAILY_SGDAILY_USHOLDMONTHLYWEEKLYWEEKLY_MON_TO_FRI_AUWEEKLY_MON_TO_FRI_EUWEEKLY_MON_TO_FRI_USWEEKLY_ON_TUE_FRI_MIDNIGHTWEEKLY_SUN_TO_THU_AUWEEKLY_SUN_TO_THU_US
payoutScheduleReason
string 
optional
The reason for the payout schedule choice.
Required if the payoutSchedule is HOLD.
payoutSpeed
enum<string> 
optional
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
Allowed values:
INSTANTSAME_DAYSTANDARD
Default:
STANDARD
Examples

Responses

🟢200OK - the request has succeeded.
application/json
Body
accountCode
string 
optional
The code of the new account.
accountHolderCode
string 
optional
The code of the account holder.
bankAccountUUID
string 
optional
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.
description
string 
optional
The description of the account.
invalidFields
array[object (ErrorFieldType) {3}] 
optional
A list of fields that caused the /createAccount request to fail.
errorCode
integer <int32>
optional
The validation error code.
errorDescription
string 
optional
A description of the validation error.
fieldType
object (FieldType) 
optional
The type of error field.
metadata
object 
optional
A set of key and value pairs containing metadata.
Additional properties
string 
optional
payoutMethodCode
string 
optional
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
object (PayoutScheduleResponse) 
optional
The payout schedule of the account.
nextScheduledPayout
string <date-time>
optional
The date of the next scheduled payout.
schedule
enum<string> 
optional
The payout schedule of the account.
Permitted 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.
Allowed values:
BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHTDAILYDAILY_AUDAILY_EUDAILY_SGDAILY_USHOLDMONTHLYWEEKLYWEEKLY_MON_TO_FRI_AUWEEKLY_MON_TO_FRI_EUWEEKLY_MON_TO_FRI_USWEEKLY_ON_TUE_FRI_MIDNIGHTWEEKLY_SUN_TO_THU_AUWEEKLY_SUN_TO_THU_US
payoutSpeed
enum<string> 
optional
Speed with which payouts for this account are processed. Permitted values: STANDARD, SAME_DAY.
Allowed values:
INSTANTSAME_DAYSTANDARD
pspReference
string 
optional
The reference of a request. Can be used to uniquely identify the request.
resultCode
string 
optional
The result code.
status
enum<string> 
optional
The status of the account.
Permitted values: Active.
Allowed values:
ActiveClosedInactiveSuspended
🟢202Accepted - the request has been accepted for processing, but the processing has not been completed.
🟠400Bad Request - a problem reading or understanding the request.
🟠401Unauthorized - authentication required.
🟠403Forbidden - insufficient permissions to process the request.
🟠422Unprocessable Entity - a request validation error.
🔴500Internal Server Error - the server could not process the request.
Modified at 2023-08-15 06:33:33
Previous
Close an account
Next
Update an account
Built with