🏦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

post

/customers/{customerId}/accounts

Authorizations

Path parameters

customerIdstring · uuidrequired

Unique customer ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Idempotency-Keystring · uuidrequired

Idempotency key (UUID)

Content-Digeststringrequired

Content digest

Body

typestring · enumrequired

Type of the account

Options: card_account

currenciesstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.offblocks.xyz/v1/customers/{customerId}/accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000' \
  --header 'Content-Digest: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "card_account",
    "currencies": [
      "text"
    ]
  }'

201

400

401

404

500

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "createdAt": "2025-02-28T07:30:03.310Z",
  "updatedAt": "2025-02-28T07:30:03.310Z",
  "currencies": [
    "text"
  ],
  "challenge": "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZZd0VBWUhLb1pJemowQ0FRWUZLNEVFQUFvRFFnQUUzTEw1RldmVFgvL3BJaXNEL0xneFVIT2lxdlFTSUVWTgpGekloOTdLZXBlWk1iZVZsUGd1akZ4Yk5MN2x1ZVhRQnBpUWUzNmZLN0xSbXZNNHdEaWZFTkE9PQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0="
}

Successful operation

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

get

/accounts

Authorizations

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.offblocks.xyz/v1/accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

500

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    "status": "initiating",
    "type": "card_account",
    "createdAt": "2025-02-28T07:30:03.310Z",
    "updatedAt": "2025-02-28T07:30:03.310Z",
    "currencies": [
      "text"
    ]
  }
]

Successful operation

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

get

/customers/{customerId}/accounts

Authorizations

Path parameters

customerIdstring · uuidrequired

Unique customer ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.offblocks.xyz/v1/customers/{customerId}/accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    "status": "initiating",
    "type": "card_account",
    "createdAt": "2025-02-28T07:30:03.310Z",
    "updatedAt": "2025-02-28T07:30:03.310Z",
    "currencies": [
      "text"
    ]
  }
]

Successful operation

Retrieve an Individual Account

To retrieve information about an individual account, make a GET request to /accounts/{accountId}.

Retrieve account

Retrieves account's details

get

/accounts/{accountId}

Authorizations

Path parameters

accountIdstring · uuidrequired

Unique account ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.offblocks.xyz/v1/accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "createdAt": "2025-02-28T07:30:03.310Z",
  "updatedAt": "2025-02-28T07:30:03.310Z",
  "currencies": [
    "text"
  ]
}

Successful operation

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

patch

/accounts/{accountId}/deactivate

Authorizations

Path parameters

accountIdstring · uuidrequired

Unique account ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Idempotency-Keystring · uuidrequired

Idempotency key (UUID)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/accounts/{accountId}/deactivate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'

200

400

401

404

409

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "createdAt": "2025-02-28T07:30:03.310Z",
  "updatedAt": "2025-02-28T07:30:03.310Z",
  "currencies": [
    "text"
  ]
}

Successful operation

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

patch

/accounts/{accountId}/activate

Authorizations

Path parameters

accountIdstring · uuidrequired

Unique account ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Idempotency-Keystring · uuidrequired

Idempotency key (UUID)

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/accounts/{accountId}/activate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'

200

400

401

404

409

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "createdAt": "2025-02-28T07:30:03.310Z",
  "updatedAt": "2025-02-28T07:30:03.310Z",
  "currencies": [
    "text"
  ]
}

Successful operation

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

delete

/accounts/{accountId}

Authorizations

Path parameters

accountIdstring · uuidrequired

Unique account ID

Header parameters

Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Idempotency-Keystring · uuidrequired

Idempotency key (UUID)

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.offblocks.xyz/v1/accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'

204

400

401

404

409

500

204

No body

Successful operation