OffBlocks
  • 👋Welcome to OffBlocks
  • Overview
    • 💡What we do
    • ✨Core Concepts
    • 📜Whitepaper
    • ⛓️Supported Blockchains and Assets
    • ❔FAQ
  • Developer Guides
    • 🏗️System Architecture
    • ⚙️API Integration
      • 🚀Getting Started
      • 📯Postman
      • 🔑Authentication
      • 🔏Request Signatures
      • 🆔Idempotency
      • ⛓️Blockchain Identifiers
      • 📒Blockchain Updates
      • 📲Sign in With X
      • 💰Fees
      • 🕹️Simulator
      • 🔢API Reference
        • 🦸‍♂️Customers
        • 🏦Accounts
        • 💳Cards
        • 🔃Transactions
        • 🪝Webhooks
        • 🕹️Simulator
        • 🚂Engine
      • ⏭️States and Transitions
        • 🦸‍♂️Customer States
        • 🏦Account States
        • 💳Card States
        • 🔑Authorisation States
        • 🔃Transaction States
    • 🧬Smart Contracts
      • OffBlocksEscrow.sol
      • OffBlocksSmartWalletFactory.sol
      • OffBlocksSmartWallet.sol
      • PendingWithdrawal.sol
      • Interfaces
    • 🔢Step-by-step Guide
      • 1️⃣API Credentials
      • 2️⃣Authentication
      • 3️⃣Request Preparation
      • 4️⃣Customer Creation
      • 5️⃣Customer Verification
      • 6️⃣Account Creation
      • 7️⃣Card Issuance
      • 8️⃣Card Authorisations
      • 9️⃣Webhooks
  • Use Cases
    • 💰Wallet Providers
    • 🧑‍🌾DeFi Apps
    • 🏦Neo-banks and FinTechs
Powered by GitBook
On this page
  1. Developer Guides
  2. API Integration
  3. API Reference

Simulator

PreviousWebhooksNextEngine

Last updated 1 year ago

Customer Verifications

Verify Customer

To verify a customer with pending verification and proceed with activation, make a PATCH request to /simulator/customers/{customerId}/verify.

Reject Customer

To reject a customer with pending verification, make a PATCH request to /simulator/customers/{customerId}/reject.

Cards

Issue Card

To approve a pending card issuance request and proceed with activation, make a PATCH request to /simulator/cards/{cardId}/issue.

Fail Card Issuance

To fail a pending card issuance request, make a PATCH request to /simulator/cards/{cardId}/fail.

Authorisations

Initiate Card Authorisation

To initiate a card authorisation for a specified card, make a POST request to /simulator/cards/{cardId}/authorisation. You have an option to automatically capture the created authorisation upon approval.

Capture Authorisation

To capture a pending card authorisation which was not initiated with automatic capture mode, make a PATCH request to /simulator/authorisations/{authorisationId}/capture.

Release Authorisation

To release a pending card authorisation which was not initiated with automatic capture mode, make a PATCH request to /simulator/authorisations/{authorisationId}/release.

⚙️
🔢
🕹️

Verify customer

Simulates customer verification success

patch

/simulator/customers/{customerId}/verify

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)

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/customers/{customerId}/verify' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

Reject customer

Simulates customer verification rejection

patch

/simulator/customers/{customerId}/reject

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)

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/customers/{customerId}/reject' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

Issue card

Simulates card issuing success

patch

/simulator/cards/{cardId}/issue

Authorizations
Path parameters
cardIdstring · uuidrequired

Unique card 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 -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/cards/{cardId}/issue' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

Fail card issuance

Simulates card issuing failure

patch

/simulator/cards/{cardId}/fail

Authorizations
Path parameters
cardIdstring · uuidrequired

Unique card 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 -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/cards/{cardId}/fail' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

Initiate card authorisation

Simulates card authorisation

post

/simulator/cards/{cardId}/authorisation

Authorizations
Path parameters
cardIdstring · uuidrequired

Unique card ID

Header parameters
Signaturestringrequired

HTTP message signature

Signature-Inputstringrequired

HTTP message signature input

Idempotency-Keystring · uuidrequired

Idempotency key (UUID)

Content-Digeststringrequired

Content digest

Body
amountstring · decimalrequired

Amount to be authorised

captureboolean · default: truerequired

Whether to capture the authorisation immediately

currencystringrequired

Authorisation currency (ISO-4217)

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url 'https://api.offblocks.xyz/v1/simulator/cards/{cardId}/authorisation' \
  --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 '{
    "amount": "10.0",
    "capture": true,
    "currency": "EUR"
  }'
201
400
401
404
500
{
  "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:22:18.836Z",
  "updatedAt": "2025-02-28T07:22:18.836Z",
  "currency": "EUR",
  "merchantCurrency": "EUR"
}

Successful operation

Capture card authorisation

Simulates card authorisation capture

patch

/simulator/authorisations/{authorisationId}/capture

Authorizations
Path parameters
authorisationIdstring · uuidrequired

Unique authorisation 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 -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/capture' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

Release card authorisation

Simulates card authorisation release

patch

/simulator/authorisations/{authorisationId}/release

Authorizations
Path parameters
authorisationIdstring · uuidrequired

Unique authorisation 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 -L \
  --request PATCH \
  --url 'https://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/release' \
  --header 'Authorization: Bearer JWT' \
  --header 'Signature: text' \
  --header 'Signature-Input: text' \
  --header 'Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000'
202
400
401
404
500
No body

Successful operation

  • Customer Verifications
  • Verify Customer
  • PATCHVerify customer
  • Reject Customer
  • PATCHReject customer
  • Cards
  • Issue Card
  • PATCHIssue card
  • Fail Card Issuance
  • PATCHFail card issuance
  • Authorisations
  • Initiate Card Authorisation
  • POSTInitiate card authorisation
  • Capture Authorisation
  • PATCHCapture card authorisation
  • Release Authorisation
  • PATCHRelease card authorisation