7️⃣Card Issuance

This step assumes you have successfully created a new account record using Account Creationstep of the guide

Now that you have created a customer account, you are able to issue cards for the account. To do so, you need to use /accounts/{accountId}/card POST request.

Create new card

Creates new card for the account

post

/accounts/{accountId}/cards

Authorizations

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)

Content-Digeststringrequired

Content digest

Body

typestring · enumrequired

Card type

Options: virtual, physical

billingAddressobjectrequired

Billing address of a cardholder

shippingAddressobject

Shipping address for the card. Required for physical cards

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.offblocks.xyz/v1/accounts/{accountId}/cards' \
  --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 '{
    "type": "virtual",
    "billingAddress": {
      "state": "text",
      "firstLine": "Flat G",
      "secondLine": "321 West End Lane",
      "city": "London",
      "country": "GB",
      "postCode": "NW6 2FG"
    },
    "shippingAddress": {
      "state": "text",
      "firstLine": "Flat G",
      "secondLine": "321 West End Lane",
      "city": "London",
      "country": "GB",
      "postCode": "NW6 2FG"
    }
  }'

201

400

401

404

500

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "type": "virtual",
  "network": "visa",
  "billingAddress": {
    "state": "text",
    "firstLine": "Flat G",
    "secondLine": "321 West End Lane",
    "city": "London",
    "country": "GB",
    "postCode": "NW6 2FG"
  },
  "status": "issuing",
  "createdAt": "2025-02-28T07:43:38.479Z",
  "updatedAt": "2025-02-28T07:43:38.479Z",
  "name": "John Carter",
  "maskedPan": "530518******9871",
  "expirationDate": "10/2028"
}

Successful operation

Let's say we want to open a new virtual card (physical cards are not supported at the moment):

{
  "type": "virtual",
  "billingAddress": {
    "firstLine": "1 Test Avenue",
    "city": "London",
    "country": "GB",
    "postCode": "SW1 1AA"
  }
}

If everything was successful, you will receive a response with status 201 (Created) which looks similar to the following:

{
    "accountId": "ae61c362-4136-49af-8e01-544457fe265b",
    "billingAddress": {
        "city": "London",
        "country": "GB",
        "firstLine": "1 Test Avenue",
        "postCode": "SW1 1AA"
    },
    "createdAt": "2024-01-12T15:12:26.923705379Z",
    "id": "fc4912aa-cac9-4bb0-a6a7-6ec50bf45879",
    "status": "issuing",
    "type": "virtual",
    "updatedAt": "2024-01-12T15:12:26.923705379Z"
}

At this stage, you can use our Simulator to issue or fail a pending card issuance request.

Assuming you would like to issue the card and proceed with next steps, you need to make an empty PATCH request to /simulator/cards/{cardId}/issue.

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

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

202

No body

Successful operation

If your request was successful, you will receive an empty response with status 202 (Accepted).

In our Sandbox environment the card will be automatically issued and activated, which you can verify by making a GET request to /cards/{cardId}.

Retrieve card

Retrieves card's details

get

/cards/{cardId}

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}' \
  --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",
  "type": "virtual",
  "network": "visa",
  "billingAddress": {
    "state": "text",
    "firstLine": "Flat G",
    "secondLine": "321 West End Lane",
    "city": "London",
    "country": "GB",
    "postCode": "NW6 2FG"
  },
  "status": "issuing",
  "createdAt": "2025-02-28T07:43:38.479Z",
  "updatedAt": "2025-02-28T07:43:38.479Z",
  "name": "John Carter",
  "maskedPan": "530518******9871",
  "expirationDate": "10/2028"
}

Successful operation

{
    "accountId": "ae61c362-4136-49af-8e01-544457fe265b",
    "billingAddress": {
        "city": "London",
        "country": "GB",
        "firstLine": "1 Test Avenue",
        "postCode": "SW1 1AA"
    },
    "createdAt": "2024-01-12T15:12:26.923705Z",
    "id": "fc4912aa-cac9-4bb0-a6a7-6ec50bf45879",
    "status": "active",
    "type": "virtual",
    "updatedAt": "2024-01-12T15:16:03.983949Z"
}

From there we can proceed to simulating card authorisations and transactions.