Card Suspension

You can suspend a card by making use of the block card API. When a card is suspended, the user will not be able to make transactions on the card, but a suspended card can be reactivated at any time using the unblock card endpoint.

📘

The block card API offers two sets of endpoints :

• The block card endpoint can be used to block and unblock both prepaid and debit cards. See its path below:

/card-management/api/v1/card/

• The prepaid card endpoint also has its own endpoint for blocking and unblocking. See its path below:

/card-management/api/v1/card/prepaid/

Feel free to use any one that suits your use case.

Block A Card

To block a card successfully, make a POST Request to the block card endpoint.

/card-management/api/v1/card/block

These are the parameters of the request:

Query Parameters description

Body Parameters

This is what a typical request would look like:

{
  "pan": "5060990000000151002",
  "holdRspCode": "41",
  "seqNr": "001",
  "expiryDate": "5004"
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5daa9a3f6ce9497d84c559aea9f924b3"
}

{
  "code": "400",
  "description": "Unsuccessful",
  "correlationId": "d5c294c81e904a21b3847a5f2b91de44",
  "errors": [
    {
      "message": "File Update error - Card Lookup Failed",
      "fieldName": "27 - P003"
    }
  ]
}

Unblock A Card

To unblock a card successfully make a POST Request to the unblock card endpoint .

/card-management/api/v1/card/unblock

These are the parameters of the request:

Query Parameters description

Body Parameters

This is what a typical request would look like:

  "pan": "5060990000000151002",
  "seqNr": "001",
  "expiryDate": "5004"
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5daa9a3f6ce9497d84c559aea9f924b3"
}

{
  "code": "400",
  "description": "[not a valid card number]",
  "errors": [
    {
      "message": "not a valid card number",
      "fieldName": "pan"
    }
  ]
}

Block A Prepaid Card

To block a prepaid card successfully, make a POST Request to the block prepaid card endpoint .

/card-management/api/v1/card/prepaid/block

These are the parameters of the request:

Body Parameters

This is what a typical request would look like:

{
  "pan": "5060990000000151002",
  "holdRspCode": "41",
  "seqNr": "001",
  "expiryDate": "5004"
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5daa9a3f6ce9497d84c559aea9f924b3"
}

{
  "code": "400",
  "description": "[required, length must be 2]",
  "errors": [
    {
      "message": "required",
      "fieldName": "holdRspCode"
    },
    {
      "message": "length must be 2",
      "fieldName": "holdRspCode"
    }
  ]
}

Unblock A Card

To unblock a pre-paid card successfully make a POST Request to the unblock prepaid card endpoint.

/card-management/api/v1/card/prepaid/unblock

These are the parameters of the request:

Body Parameters

This is what a typical request would look like:

  "pan": "5060990000000151002",
  "seqNr": "001",
  "expiryDate": "5004"
}

Response Message  field description

This is what a typical successful or failed response would look like

{
  "code": "00",
  "description": "Successful",
  "correlationId": "5daa9a3f6ce9497d84c559aea9f924b3"
}

{
  "code": "400",
  "description": "[not a valid card number]",
  "errors": [
    {
      "message": "not a valid card number",
      "fieldName": "pan"
    }
  ]
}