🕹️Simulator

Customer Verifications

Verify Customer

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

Verify customer

Simulates customer verification success

PATCHhttps://api.offblocks.xyz/v1/simulator/customers/{customerId}/verify

Authorization

bearerAuth

Path parameters

customerId*CardId (string (uuid))

ID of customer to be verified

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/customers/{customerId}/verify', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Reject Customer

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

Reject customer

Simulates customer verification rejection

PATCHhttps://api.offblocks.xyz/v1/simulator/customers/{customerId}/reject

Authorization

bearerAuth

Path parameters

customerId*CustomerId (any)

Unique customer ID

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/customers/{customerId}/reject', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Cards

Issue Card

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

Issue card

Simulates card issuing success

PATCHhttps://api.offblocks.xyz/v1/simulator/cards/{cardId}/issue

Authorization

bearerAuth

Path parameters

cardId*CardId (string (uuid))

ID of card to be issued

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/cards/{cardId}/issue', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

Fail Card Issuance

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

Fail card issuance

Simulates card issuing failure

PATCHhttps://api.offblocks.xyz/v1/simulator/cards/{cardId}/fail

Authorization

bearerAuth

Path parameters

cardId*CardId (any)

Unique card ID

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/cards/{cardId}/fail', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

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.

Initiate card authorisation

Simulates card authorisation

POSThttps://api.offblocks.xyz/v1/simulator/cards/{cardId}/authorisation

Authorization

bearerAuth

Path parameters

cardId*CardId (any)

Unique card ID

Header parameters

Body

application/json

amount*Decimal (string (decimal))

Decimal number

currency*string

Authorisation currency (ISO-4217)

capture*boolean

Whether to capture the authorisation immediately

Response

201400401404500

Successful operation

Body

application/json

id*CardId (string (uuid))

accountId*CardId (string (uuid))

cardIdCardId (string (uuid))

status*AuthorisationStatus (enum)

Authorisation status

pendingcapturingcapturedreleasingreleased

amount*Decimal (string (decimal))

Decimal number

currency*string

Currency of the account (ISO-4217)

merchantAmount*Decimal (string (decimal))

Decimal number

merchantCurrency*string

Origin currency of the merchant (ISO-4217)

exchangeRate*Decimal (string (decimal))

Decimal number

merchant*Merchant (object)

Merchant information

createdAt*DateTime (string (date-time))

ISO-8601 timestamp

updatedAt*DateTime (string (date-time))

ISO-8601 timestamp

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/cards/{cardId}/authorisation', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000",
      "Content-Digest": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "amount": "text",
      "currency": "text",
      "capture": true
    }),
});
const data = await response.json();

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "cardId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "text",
  "currency": "text",
  "merchantAmount": "text",
  "merchantCurrency": "text",
  "exchangeRate": "text",
  "merchant": {
    "id": "text",
    "name": "text",
    "country": "text",
    "city": "text"
  },
  "createdAt": "2024-11-21T06:29:35.747Z",
  "updatedAt": "2024-11-21T06:29:35.747Z"
}

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.

Capture card authorisation

Simulates card authorisation capture

PATCHhttps://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/capture

Authorization

bearerAuth

Path parameters

authorisationId*CardId (string (uuid))

ID of authorisation to be captured

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/capture', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();

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.

Release card authorisation

Simulates card authorisation release

PATCHhttps://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/release

Authorization

bearerAuth

Path parameters

authorisationId*AuthorisationId (any)

Unique authorisation ID

Header parameters

Response

202400401404500

Successful operation

Request

JavaScriptCurlPython

const response = await fetch('https://api.offblocks.xyz/v1/simulator/authorisations/{authorisationId}/release', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Signature": "text",
      "Signature-Input": "text",
      "Idempotency-Key": "123e4567-e89b-12d3-a456-426614174000"
    },
});
const data = await response.json();