🏦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

post

/customers/{customerId}/accounts

Creates new account for the customer and generates a challenge to be signed in order to create a related blockchain account

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

Possible values:

currenciesstring[]Required

Currencies of the account, at least one is required (ISO-4217)

Responses

201

Successful operation

application/json

Cryptographic challenge generated to be signed by owner's EOA private key according to chain-specific algorithm. Challenge is used for verifying ownership of the account and signing on-chain transactions such as creating a new account, authorising a recurring payment or setting up spending limits

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

challengestring · byteRequired

Base64 encoded message provided by this API for owner to sign

Example:

LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZZd0VBWUhLb1pJemowQ0FRWUZLNEVFQUFvRFFnQUUzTEw1RldmVFgvL3BJaXNEL0xneFVIT2lxdlFTSUVWTgpGekloOTdLZXBlWk1iZVZsUGd1akZ4Yk5MN2x1ZVhRQnBpUWUzNmZLN0xSbXZNNHdEaWZFTkE9PQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0=

400

Invalid request

401

Not authorised

404

Customer not found

500

Internal error

post/customers/{customerId}/accounts

POST /v1/customers/{customerId}/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Digest: text
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "type": "card_account",
  "currencies": [
    "text"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "currencies": [
    "text"
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "challenge": "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUZZd0VBWUhLb1pJemowQ0FRWUZLNEVFQUFvRFFnQUUzTEw1RldmVFgvL3BJaXNEL0xneFVIT2lxdlFTSUVWTgpGekloOTdLZXBlWk1iZVZsUGd1akZ4Yk5MN2x1ZVhRQnBpUWUzNmZLN0xSbXZNNHdEaWZFTkE9PQotLS0tLUVORCBQVUJMSUMgS0VZLS0tLS0="
}

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

get

/accounts

Retrieves accounts' details

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

SignaturestringRequired

HTTP message signature

Signature-InputstringRequired

HTTP message signature input

Responses

200

Successful operation

application/json

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

400

Invalid request

401

Not authorised

500

Internal error

get/accounts

GET /v1/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    "status": "initiating",
    "type": "card_account",
    "currencies": [
      "text"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

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

get

/customers/{customerId}/accounts

Retrieves customer's accounts

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customerIdstring · uuidRequired

Unique customer ID

Header parameters

SignaturestringRequired

HTTP message signature

Signature-InputstringRequired

HTTP message signature input

Responses

200

Successful operation

application/json

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

400

Invalid request

401

Not authorised

404

Customer not found

500

Internal error

get/customers/{customerId}/accounts

GET /v1/customers/{customerId}/accounts HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
    "status": "initiating",
    "type": "card_account",
    "currencies": [
      "text"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
]

Retrieve an Individual Account

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

Retrieve account

get

/accounts/{accountId}

Retrieves account's details

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstring · uuidRequired

Unique account ID

Header parameters

SignaturestringRequired

HTTP message signature

Signature-InputstringRequired

HTTP message signature input

Responses

200

Successful operation

application/json

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

400

Invalid request

401

Not authorised

404

Account not found

500

Internal error

get/accounts/{accountId}

GET /v1/accounts/{accountId} HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "currencies": [
    "text"
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

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

patch

/accounts/{accountId}/deactivate

Deactivates account and all associated resources

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

Successful operation

application/json

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

400

Invalid request

401

Not authorised

404

Account not found

409

Invalid state transition

500

Internal error

patch/accounts/{accountId}/deactivate

PATCH /v1/accounts/{accountId}/deactivate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "currencies": [
    "text"
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

Reactivate an Account

To reactivate a previously deactivated account, use a PATCH request to /accounts/{accountId}/activate.

Activate account

patch

/accounts/{accountId}/activate

Activates account and all associated resources

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

Successful operation

application/json

idstring · uuidRequired

Unique account ID

customerIdstring · uuidRequired

Unique customer ID

chainIdstringOptional

Unique account ID in a form of a valid on-chain address. This would normally correspond to account's SCA address

Example: eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb

statusstring · enumRequired

Account status

Possible values:

typestring · enumRequired

Type of the account

Possible values:

currenciesstring[]Optional

Currencies of the account, at least one is required (ISO-4217)

createdAtstring · date-timeRequired

Date this account was created (ISO-8601)

updatedAtstring · date-timeRequired

Date this account was updated (ISO-8601)

400

Invalid request

401

Not authorised

404

Account not found

409

Invalid state transition

500

Internal error

patch/accounts/{accountId}/activate

PATCH /v1/accounts/{accountId}/activate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "chainId": "eip155:1:0xab16a96D359eC26a11e2C2b3d8f8B8942d5Bfcdb",
  "status": "initiating",
  "type": "card_account",
  "currencies": [
    "text"
  ],
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

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

delete

/accounts/{accountId}

Closes account and generates a challenge to be signed in order to delete related blockchain account

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

204

Successful operation

No content

400

Invalid request

401

Not authorised

404

Account not found

409

Invalid state transition

500

Internal error

delete/accounts/{accountId}

DELETE /v1/accounts/{accountId} HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

PreviousCustomers NextCards

Last updated 2 years ago