π¦Accounts
API reference for account-related endpoints
Creating a New Account for a Customer
A new account for a customer can be created using the POST
endpoint: /customers/{customerId}/accounts
. .
Create new customer account
Creates new account for the customer and generates a challenge to be signed in order to create a related blockchain account
ID of customer
Type of the account
Currencies of the account, at least one is required (ISO-4217)
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Base64 encoded message provided by this API for owner to sign
Account Entity Updates
Any internal updates to the account entity will be reported through webhook update events. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.
Blockchain Updates
To proceed with account deployment and activation, a challenge issued by the endpoint must be signed and verified (see Blockchain Updates).
Retrieve Account Entities
To retrieve a list of all account entities registered for the programme, make a GET
request to /accounts
.
Retrieve accounts
Retrieves accounts' details
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Retrieve an Individual Customer's Accounts
To retrieve information about an individual customer's accounts, make a GET
request to /customers/{customerId}/account
with the customer ID as a path parameter.
Retrieve customer accounts
Retrieves customer's accounts
Unique customer ID
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Retrieve an Individual Account
To retrieve information about an individual account, make a GET
request to /accounts/{accountId}
.
Retrieve account
Retrieves account's details
ID of account to be retrieved
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Deactivate an Account
To deactivate an account, use a PATCH
request to /accounts/{accountId}/deactivate
. This action will also deactivate all associated resources, such as cards.
Deactivate account
Deactivates account and all associated resources
Unique account ID
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Reactivate an Account
To reactivate a previously deactivated account, use a PATCH
request to /accounts/{accountId}/activate
.
Activate account
Activates account and all associated resources
Unique account ID
Successful operation
Universal unique on-chain identifier of the account following CAIP-10 specification
Account status
Type of the account
Currencies of the account, at least one is required (ISO-4217)
ISO-8601 timestamp
ISO-8601 timestamp
Closing an Account
An account can be closed and subsequently removed from the programme using a DELETE
request to /account/{accountId}
. This will also deactivate all associated resources, including cards, and irreversibly deactivate the smart contract associated with it. All data will be preserved for audit and compliance purposes.
Close account
Closes account and generates a challenge to be signed in order to delete related blockchain account
Unique account ID
Successful operation
Last updated