π³Cards
API reference for card-related endpoints
Creating and Ordering a New Card for a Customer
A new card for the customer can be created and ordered using the POST
endpoint: /customers/{customerId}/cards
. This operation creates a new card through our issuance partner with Visa or MasterCard. If a physical card is requested, it also initiates a shipment order to the specified address. Please note that each card is linked to a specific account, and currently, we only support a limit of one virtual and one physical card per customer's account.
Creates new card for the account
Unique account ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
Content digest
Card type
POST /v1/accounts/{accountId}/cards 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: 299
{
"type": "virtual",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"shippingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
}
}
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
Card Entity Updates
Any internal updates to the card entity will be reported through webhook update events. For details on how to set up and manage webhook subscriptions, please refer to Webhooks.
Retrieve Cards for a Specific Account
To retrieve a list of cards associated with a specific account, make a GET
request to /accounts/{accountId}/cards
.
Retrieves account's cards
Unique account ID
HTTP message signature
HTTP message signature input
GET /v1/accounts/{accountId}/cards HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
]
Retrieve All Cards
To retrieve a list of all cards associated with the programme, make a GET
request to /cards
. To fetch details of a specific card by ID, use a GET
request to /cards/{cardId}
.
Retrieves cards' details
HTTP message signature
HTTP message signature input
GET /v1/cards HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
]
Retrieve an Individual Card
To retrieve information about an individual card, make a GET
request to /cards/{cardId}
.
Retrieves card's details
Unique card ID
HTTP message signature
HTTP message signature input
GET /v1/cards/{cardId} HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
Deactivate a Card
To deactivate a card, use a PATCH
request to /cards/{cardId}/deactivate
.
Deactivates card and all associated resources
Unique card ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
PATCH /v1/cards/{cardId}/deactivate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
Reactivate a Card
To reactivate a previously deactivated card, use a PATCH
request to /cards/{cardId}/activate
.
Activates card and all associated resources
Unique card ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
PATCH /v1/cards/{cardId}/activate HTTP/1.1
Host: api.offblocks.xyz
Authorization: Bearer JWT
Signature: text
Signature-Input: text
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"accountId": "123e4567-e89b-12d3-a456-426614174000",
"type": "virtual",
"name": "John Carter",
"network": "visa",
"maskedPan": "530518******9871",
"expirationDate": "10/2028",
"billingAddress": {
"firstLine": "Flat G",
"secondLine": "321 West End Lane",
"city": "London",
"state": "text",
"country": "GB",
"postCode": "NW6 2FG"
},
"status": "issuing",
"createdAt": "2025-07-10T02:30:07.130Z",
"updatedAt": "2025-07-10T02:30:07.130Z"
}
Terminate a Card
A card can be terminated using a DELETE
request to /cards/{cardId}
. This is an irreversible operation, and the card will not be available for new payments. However, it will remain active for pending holds for up to 30 days.
Terminates card
Unique card ID
HTTP message signature
HTTP message signature input
Idempotency key (UUID)
DELETE /v1/cards/{cardId} 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