Create Account
Create account
- application/json
Request Body required
- oneOf
- Create non-custodial cardholder account
- Create custodial cardholder account
- Create partner account
type string requiredPossible values: [
cardholder
]The type of the account
name stringAccount name
partnerAccountId string requiredThe id of the partner account that this cardholder must be linked to
ownerUserId string requiredThis user will be set as the owner of the created account
type string requiredPossible values: [
cardholder
]The type of the account
name stringAccount name
parentAccountId string requiredThe id of the partner account that this cardholder must be made child of
type string requiredPossible values: [
partner
]The type of the account
name string requiredAccount name
parentAccountId stringParent account. If provided, this account will be set as the parent of the created account
ownerUserId stringOwner user id. If provided, this user will be set as the owner of the created account
- 200
- 400
- 403
Account created successfully
- application/json
- Schema
- Example (from schema)
Schema
- id string
The unique account ID
- createdAt string
Timestamp of account creation
- modifiedAt string
Timestamp of last account modification
- partnerAccountId string
The partner account ID that this account belongs to
- isActive boolean
Whether the account is active or not
- type string
Possible values: [
cardholder
,identity
,partner
]The account type
{
"id": "e4b66d1ddecbf518f5f337n5e5a4f682",
"createdAt": "2022-11-16T03:13:18.142Z",
"modifiedAt": "2022-11-18T03:13:18.142Z",
"partnerAccountId": "c7d84a7bf1c34323732d21bc60d17s746",
"isActive": true,
"type": "cardholder"
}
Request fields are invalid
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- errors string[]
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "BAD_REQUEST",
"errors": [
"Expected string, received number"
]
}
User is not allowed to perform the action with the reason stated in the errorCode
FORBIDDEN Insufficient permissions to perform the action.
INVALID_PARTNER_ACCOUNT The provided partner account is not of type partner.
INVALID_PARENT_ACCOUNT The provided parent account is not of type partner.
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- reason string
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}