Activate, Suspend or Terminate Virtual Card via API

To activate or deactivate a card, make a PATCH request to the endpoint below.

{{baseurl}}/api/i/cards/:card_reference/status

When initiating the request, remember to pass the card_reference as a request parameter.

Here are the parameters for the request body:

Field	Data Type	Description
`action`	String	Required - Can be one of `activate` or `deactivate`.
`reason`	String	Required - The reason for the update.

Activating a Card via API

An example of a request to activate a card could look like this:

{
    "action": "activate",
    "reason": "Cleared of fraud charges"
}

The response will look something like this:

{
    "status": true,
    "message": "Card activated successfully ",
    "data": {
        "status": "active"
    }
}

A webhook notification will also be sent to your application when a virtual card is activated. The webhook notification response will look like this:

{
 "event": "card.active",
 "data": {
   "reference": "webhook unique reference",
   "card_reference": "876eeb6f-f6cb-562f-a5e8-48d91dec7999",
   "status": "active",
   "date": "2000-11-11T10:00:00"
 }
}

Suspending or Deactivating a Card via API

Here's a sample request for when you want to suspend or deactivate a card:

{
    "action": "suspend",
    "reason": "Fraudulent activities"
}

The response to this request could look like this:

{
    "status": true,
    "message": "Card deactivated successfully",
    "data": {
        "status": "suspended"
    }
}

A webhook notification will also be sent to your application when a virtual card is deactivated/suspended. The webhook notification response will look like this:

{
 "event": "card.suspended",
 "data": {
   "reference": "webhook unique reference",
   "card_reference": "876eeb6f-f6cb-562f-a5e8-48d91dec7999",
   "status": "suspended",
   "date": "2000-11-11T10:00:00"
 }
}

Terminate a Card via API

To terminate a card, make a PATCH request to the endpoint below:

{{baseurl}}/api/i/cards/:card_reference/terminate

You will need to pass the card_reference as a request parameter when initiating this request.

The request body is as follows:

Field	Data Type	Description
`reason`	String	Required - The reason for the update.
`initiator`	String	Optional - The actor initiating the request

Here's an example of the request.

{
    "reason": "Card no longer in use",
    "initiator": “Janet Doe”
}

For this request, this is what a response could look like:

{
    "status": true,
    "message": "Card terminated successfully",
    "data": {
        "status": "terminated"
    }
}

A webhook notification will also be sent to your application when a virtual card is terminated. The webhook notification response will look like this:

{
 "event": "card.terminated",
 "data": {
   "reference": "webhook unique reference",
   "card_reference": "876eeb6f-f6cb-562f-a5e8-48d91dec7999",
   "status": "terminated",
   "date": "2000-11-11T10:00:00"
 }
}