Skip to main content

Manage virtual cards

You can use our APIs to manage your portfolio of virtual cards. In this section, we will cover:

  • List all virtual cards belonging to a customer
  • Get details of a virtual card
  • Locking/Unlocking a virtual card
  • Deleting a virtual card

List all virtual cards​

The List virtual cards API can be used to list all virtual cards belonging to a customer.

Please set the instrument to manual_card_entry and add either the tenant_customer_ref or tenant_account_ref to specify the customer.

Sample Request
/v1/pba/static?tenant_customer_ref=customer-00000000000001
Sample Response
{
  "data": [
    {
      "id": "4fbc4775-466c-4d21-bb8c-95f3ef9ffbea",
      "tenant_account_ref": "FR00000000000001",
      "tenant_customer_ref": "customer-00000000000001",
      "tenant_token_ref": "TOK000000000000001",
      "tsp_token_ref": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a45",
      "account_id": "c6045eed-b5cb-48f0-8321-b924a8e8f808",
      "customer_id": "5b3aae19-16b5-4aca-81b5-5d72a168c496",
      "dpan_redacted_number": "512*********9708",
      "dpan_expiry": {
        "month": "11",
        "year": "25"
      },
      "instrument": "manual_card_entry",
      "status": "active",
      "locked": false,
      "created_at": "2026-03-16T07:39:09.317Z",
      "updated_at": "2026-03-16T07:39:09.317Z"
    }
  ]  
}

Get details of a virtual card​

The Get virtual card API can be used to get details of a specific virtual card.

Sample Request
/v1/pba/static/4fbc4775-466c-4d21-bb8c-95f3ef9ffbea
Sample Response
{
  "id": "4fbc4775-466c-4d21-bb8c-95f3ef9ffbea",
  "tenant_account_ref": "FR00000000000001",
  "tenant_customer_ref": "customer-00000000000001",
  "tenant_token_ref": "TOK000000000000001",
  "tsp_token_ref": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a45",
  "account_id": "c6045eed-b5cb-48f0-8321-b924a8e8f808",
  "customer_id": "5b3aae19-16b5-4aca-81b5-5d72a168c496",
  "dpan_redacted_number": "512*********9708",
  "dpan_expiry": {
    "month": "11",
    "year": "25"
  },
  "instrument": "manual_card_entry",
  "status": "active",
  "locked": false,
  "created_at": "2026-03-16T07:39:09.317Z",
  "updated_at": "2026-03-16T07:39:09.317Z"
}

Locking/Unlocking a virtual card​

The Update virtual card API can be used to lock/unlock a specific virtual card.

Sample Request
/v1/pba/static/4fbc4775-466c-4d21-bb8c-95f3ef9ffbea
{
  "lock_status": "locked"
}
Sample Response
{
  "id": "4fbc4775-466c-4d21-bb8c-95f3ef9ffbea",
  "tenant_account_ref": "FR00000000000001",
  "tenant_customer_ref": "customer-00000000000001",
  "tenant_token_ref": "TOK000000000000001",
  "tsp_token_ref": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a45",
  "account_id": "c6045eed-b5cb-48f0-8321-b924a8e8f808",
  "customer_id": "5b3aae19-16b5-4aca-81b5-5d72a168c496",
  "dpan_redacted_number": "512*********9708",
  "dpan_expiry": {
    "month": "11",
    "year": "25"
  },
  "instrument": "manual_card_entry",
  "status": "active",
  "locked": true,
  "created_at": "2026-03-16T07:39:09.317Z",
  "updated_at": "2026-03-16T07:39:09.317Z"
}

Deleting a virtual card​

The Delete virtual card API can be used to deactivate a specific virtual card. This action is permanent (cannot be undone) and requires the virtual card to be locked first (see above) before deleting.

Sample Request
/v1/pba/static/4fbc4775-466c-4d21-bb8c-95f3ef9ffbea
{
  "reason_text": "Customer reported device is lost",
  "reason_code": "device_lost"
}
Sample Response
{
  "id": "4fbc4775-466c-4d21-bb8c-95f3ef9ffbea",
  "tenant_account_ref": "FR00000000000001",
  "tenant_customer_ref": "customer-00000000000001",
  "tenant_token_ref": "TOK000000000000001",
  "tsp_token_ref": "DWSPMC000000000132d72d4fcb2f4136a0532d3093ff1a45",
  "account_id": "c6045eed-b5cb-48f0-8321-b924a8e8f808",
  "customer_id": "5b3aae19-16b5-4aca-81b5-5d72a168c496",
  "dpan_redacted_number": "512*********9708",
  "dpan_expiry": {
    "month": "11",
    "year": "25"
  },
  "instrument": "manual_card_entry",
  "status": "deactivated",
  "locked": true,
  "created_at": "2026-03-16T07:39:09.317Z",
  "updated_at": "2026-03-16T10:09:23.368Z"
}