πŸ•ΉοΈ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

patch

Simulates customer verification success

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
202
Successful operation
patch
PATCH /v1/simulator/customers/{customerId}/verify HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

Reject Customer

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

Reject customer

patch

Simulates customer verification rejection

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
202
Successful operation
patch
PATCH /v1/simulator/customers/{customerId}/reject HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

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

patch

Simulates card issuing success

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
202
Successful operation
patch
PATCH /v1/simulator/cards/{cardId}/issue HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

Fail Card Issuance

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

Fail card issuance

patch

Simulates card issuing failure

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
202
Successful operation
patch
PATCH /v1/simulator/cards/{cardId}/fail HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

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

post

Simulates card 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

Example: 10.0
currencystringRequired

Authorisation currency (ISO-4217)

Example: EUR
capturebooleanRequired

Whether to capture the authorisation immediately

Default: true
Responses
201
Successful operation
application/json
post
POST /v1/simulator/cards/{cardId}/authorisation HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Digest: text
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "amount": "10.0",
  "currency": "EUR",
  "capture": true
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "cardId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "amount": "10.0",
  "currency": "EUR",
  "merchantAmount": "10.0",
  "merchantCurrency": "EUR",
  "exchangeRate": "10.0",
  "merchant": {
    "id": "text",
    "name": "text",
    "mcc": 1,
    "country": "text",
    "city": "text"
  },
  "createdAt": "2025-07-13T17:36:58.781Z",
  "updatedAt": "2025-07-13T17:36:58.781Z"
}

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

patch

Simulates card authorisation 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
202
Successful operation
patch
PATCH /v1/simulator/authorisations/{authorisationId}/capture HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

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

patch

Simulates card authorisation 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
202
Successful operation
patch
PATCH /v1/simulator/authorisations/{authorisationId}/release HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

No content

Last updated