Create an account

post /createAccount

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

Endpoint destination URL
Click to copy

Request parameters

accountHolderCode string Required

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

bankAccountUUID string

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

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

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.

payoutMethodCode string

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 string

The payout schedule of the prospective account.


payoutScheduleReason string

The reason for the payout schedule choice.

Required if the payoutSchedule is HOLD.

payoutSpeed string

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

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.

    Show more Show less
  • 202 - Accepted

    The request has been accepted for processing, but the processing has not been completed.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy