🔃Transactions

Authorisation

Before a debit (payment) transaction is created, we usually receive an authorisation request from a payment network. We then either approve or reject the request based on various parameters, including customer and account statuses, on-chain balances etc. If authorisation is approved and authorised funds are claimed by the merchant, we proceed with creating a transaction entity.

Retrieving a Specific Authorisation

For the time being we only support retrieving an individual authorisation entity, however we will be expanding our API soon to support more endpoints.

To retrieve an individual authorisation, make a GET request to /authorisations/{authorisationId}.

Retrieve authorisation details

Retrieves authorisation's details

get

/authorisations/{authorisationId}

Authorizations

Path parameters

authorisationIdstring · uuidrequired

Unique authorisation 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/authorisations/{authorisationId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "cardId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "10.0",
  "merchantAmount": "10.0",
  "exchangeRate": "10.0",
  "merchant": {
    "id": "text",
    "name": "text",
    "mcc": 1,
    "country": "text",
    "city": "text"
  },
  "createdAt": "2025-02-28T07:31:27.092Z",
  "updatedAt": "2025-02-28T07:31:27.092Z",
  "currency": "EUR",
  "merchantCurrency": "EUR"
}

Successful operation

Authorisation Entity Updates

Any internal updates to the authorisation entity will be reported through webhook update events. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.

Transaction

Retrieving Transactions for a Specific Account or Card

To obtain a comprehensive list of transactions for a specific account or card, initiate a GET request to the corresponding endpoint:

• /accounts/{accountId}/transactions for account transactions

Retrieve account transactions

Retrieves account's transactions

get

/accounts/{accountId}/transactions

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}/transactions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "cardId": "123e4567-e89b-12d3-a456-426614174000",
    "authorisationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "processing",
    "direction": "debit",
    "amount": "10.0",
    "merchantAmount": "10.0",
    "exchangeRate": "10.0",
    "merchant": {
      "id": "text",
      "name": "text",
      "mcc": 1,
      "country": "text",
      "city": "text"
    },
    "tokenAmount": "10.0",
    "token": "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f",
    "createdAt": "2025-02-28T07:31:27.092Z",
    "updatedAt": "2025-02-28T07:31:27.092Z",
    "currency": "EUR",
    "merchantCurrency": "EUR",
    "fees": [
      {
        "type": "partner",
        "tokenAmount": "10.0"
      }
    ],
    "chainTransactions": [
      {
        "chainId": "eip155:1:0xa3847d82245abb63692bded9da859af0b73b1bfd2409502291c39795eb14954f",
        "createdAt": "2025-02-28T07:31:27.092Z"
      }
    ]
  }
]

Successful operation

• /cards/{cardId}/transactions for card transactions

Retrieve card transactions

Retrieves card's transactions

get

/cards/{cardId}/transactions

Authorizations

Path parameters

cardIdstring · uuidrequired

Unique card 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/cards/{cardId}/transactions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "accountId": "123e4567-e89b-12d3-a456-426614174000",
    "cardId": "123e4567-e89b-12d3-a456-426614174000",
    "authorisationId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "processing",
    "direction": "debit",
    "amount": "10.0",
    "merchantAmount": "10.0",
    "exchangeRate": "10.0",
    "merchant": {
      "id": "text",
      "name": "text",
      "mcc": 1,
      "country": "text",
      "city": "text"
    },
    "tokenAmount": "10.0",
    "token": "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f",
    "createdAt": "2025-02-28T07:31:27.092Z",
    "updatedAt": "2025-02-28T07:31:27.092Z",
    "currency": "EUR",
    "merchantCurrency": "EUR",
    "fees": [
      {
        "type": "partner",
        "tokenAmount": "10.0"
      }
    ],
    "chainTransactions": [
      {
        "chainId": "eip155:1:0xa3847d82245abb63692bded9da859af0b73b1bfd2409502291c39795eb14954f",
        "createdAt": "2025-02-28T07:31:27.092Z"
      }
    ]
  }
]

Successful operation

Transaction Entity Updates

Any internal updates to the transaction entity will be reported through webhook update events. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.

Retrieving a Specific Transaction

To retrieve detailed information about a specific transaction, make a GET request to /transactions/{transactionId}.

Retrieve transaction details

Retrieves transaction's details

get

/transactions/{transactionId}

Authorizations

Path parameters

transactionIdstring · uuidrequired

Unique transaction 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/transactions/{transactionId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text'

200

400

401

404

500

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "cardId": "123e4567-e89b-12d3-a456-426614174000",
  "authorisationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "processing",
  "direction": "debit",
  "amount": "10.0",
  "merchantAmount": "10.0",
  "exchangeRate": "10.0",
  "merchant": {
    "id": "text",
    "name": "text",
    "mcc": 1,
    "country": "text",
    "city": "text"
  },
  "tokenAmount": "10.0",
  "token": "eip155:1/erc20:0x6b175474e89094c44da98b954eedeac495271d0f",
  "createdAt": "2025-02-28T07:31:27.092Z",
  "updatedAt": "2025-02-28T07:31:27.092Z",
  "currency": "EUR",
  "merchantCurrency": "EUR",
  "fees": [
    {
      "type": "partner",
      "tokenAmount": "10.0"
    }
  ],
  "chainTransactions": [
    {
      "chainId": "eip155:1:0xa3847d82245abb63692bded9da859af0b73b1bfd2409502291c39795eb14954f",
      "createdAt": "2025-02-28T07:31:27.092Z"
    }
  ]
}

Successful operation