Create an account under a specific customer
Are you looking to create an account for a specific customer? Use the following endpoint:
Endpoint | Purpose |
---|---|
POST {URI}/customers/{customerIdentifier}/accounts | Create an account under a specific customer on this platform. |
The following path parameters are used with this endpoint. customerIdentifier
is a string used to identify the Group (Customer) that contains the account you are transacting from:
Path params | Data type | Description |
---|---|---|
customerIdentifier | string | A unique identifier for the customer under which you are creating a new account. The string must have 5-100 characters. |
The following body parameters are used with this endpoint. accountIdentifier
is a string used to identify the account you are transacting from:
Body params | Data type | Description |
---|---|---|
accountIdentifier | string | A unique identifier for this account. It must be between 5-100 characters and accepts the following: -0-9a-zA-Z in any sequence. |
displayName | string | A friendly name for this account. The string must be between 5-100 characters. Emojis are not accepted for displayName or any text entry. |
contactEmail | string | An email address for a designated representative for this account. The string may have up to 100 characters. |
currencyCode | string | The only currency accepted for deposits/withdraws is AUD, CAD, EUR, GBP, or USD. Only one currency can be specified. Currency can never be changed. The currency defaults to USD if no currency is specified. |
fundingNotification | arrays of object | Send funding notification emails to the address(es). |
- emailAddress | string | (Optional) The email address used to send funding notifications to for this account. |
The following payload is an example for when you use POST {URI}/customers/{customerIdentifier}/accounts
. The account identifier must be lowercase:
{
"accountIdentifier": "string", (5-100 chars)
"displayName": "string", (100 chars)
"contactEmail": "string", (100 chars)
"currencyCode": "USD", (3 chars)
"fundingNotification": [
{
"emailAddress": "string"
}
]
}
Here's an example payload for when you receive an error:
{
"timestamp": "2025-02-21T23:23:13.930Z",
"requestId": "string",
"path": "string",
"httpCode": 0,
"httpPhrase": "string",
"i18nKey": "string",
"message": "The error message will show here for error codes ",
"errors": [
{}
]
}
The possible response codes for this endpoint are:
- 201 Created
- 400 Bad request
- 401 Unauthorized
- 403 Forbidden
- 409 Conflict, Duplicate Exist
- 500 Internal Server Error
- 503 Service Unavailable
Updated 3 days ago