Update Card Status

Block or unblock a card that was issued via the Rapyd issuing platform.

To change the status from ACT (active) to BLO (blocked), set status to block.
To change the status from BLO (blocked) to ACT (active), set status to unblock.

Prerequisite:

For a card that was issued via the API, you must activate it. See Activate Issued Card Using API.
For a card that was issued in bulk, you must personalize it. See Personalize Bulk-Issued Card.

Nota

Clients with PCI certification can handle personal identifying information for cards, such as card number.

Parameters

Request Header Parameters

Request Body Parameters

- blocked_reason
- Reason for blocking the card. Relevant when the value of status is block.
- blocked_reason_code
- Three letter code for the reason for blocking the card. One of the following values:
  - CAN - Canceled
  - COM - Compliance
  - LOC - Locked due to incorrect PIN.
  - LOS - Lost
  - MIG - Migrated
  - OTH - Other
  - REI - Reissued
  - SFR - Suspected fraud
  - STO - Stolen
- card
- The card token, which is a string starting with 'card_. If the client is PCI-certified, you can use the actual card number.
- card_status_initiator
- The initiator that asked for the card status update. One of the following three letter codes:
  - CAH - Cardholder
  - COM -Compliance operation
  - DET - Detect
  - IGW - Issuing gateway
  - ISM - Issuing merchant
  - RSK - Risk operation
  - PRO - Protect

Response Parameters

- activated_at
- Time that the card was activated, in Unix time.
- assigned_at
- Time that the card was assigned to a cardholder, in Unix time.
- blocked_reason
- Reason for blocking the card. One of the following:
  - blocked_reversible
  - canceled
  - compliance
  - locked_incorrect_pin
  - migrated
  - none
  - other
  - reissued
  - suspected_fraud
- blocked_reason_code
- Three letter code for the reason for blocking the card. One of the following values:
  - CAN - Canceled
  - COM - Compliance
  - LOC - Locked due to incorrect PIN.
  - LOS - Lost
  - MIG - Migrated
  - OTH - Other
  - REI - Reissued
  - SFR - Suspected fraud
  - STO - Stolen
- blocked_reason_desc
- Short description of the blocking reason.
- card_id
- ID of the card. String starting with card_.
- card_program
- ID of the card program. String starting with cardprog_.
- card_status_initiator
- The initiator that asked for the card status update. One of the following three letter codes:
  - CAH - Cardholder
  - COM -Compliance operation
  - DET - Detect
  - IGW - Issuing gateway
  - ISM - Issuing merchant
  - RSK - Risk operation
  - PRO - Protect
- card_status_initiator_desc
- Description of the card_status_initiator code.
- card_tracking_id
- ID of the card for purposes of tracking.
- country_iso_alpha_2
- The country where the card is issued. Two-letter ISO 3166-1 ALPHA-2 code.
- created_at
- Time of creation of the issued card object, in Unix time.
- ewallet_contact
- Describes the wallet contact that the card is assigned to. String starting with cont_. For details about the fields of the 'contact' object, see Add Contact to Wallet.
- id
- ID of the issued card object. String starting with ci_.
- metadata
- A JSON object defined by the client. See Metadata.
- public_details
- Status of the card. One of the following:
  bin - Bank ID number (BIN).
  last4 - Last 4 digits of the card.
  sub_bin - Sub-BIN.
  expiration - Expiration date as 4 digits.
- status
- Status of the card. One of the following:
  - ACT - Active.
  - BLO - Blocked.
  - IMP - Imported in bulk, but not yet personalized.
  - INA - Inactive.

Code Samples

.NET

using System;
using System.Text.Json;

namespace RapydApiRequestSample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                var requestObj = new
                {
                    card = "card_f8dd3aa099444e1c80cc5a06de38b165",
                    status = "block",

                };

                string request = JsonSerializer.Serialize(requestObj);

                string result = RapydApiRequestSample.Utilities.MakeRequest("POST", "/v1/issuing/cards/status", request);
                Console.WriteLine(result);
            }
            catch (Exception e)
            {
                Console.WriteLine("Error completing request: " + e.Message);
            }
        }
    }
}

JavaScript

const makeRequest = require('../../../../Utilities/JS/utilities').makeRequest;

async function main() {
  try {
    const body = {
      card: 'card_f8dd3aa099444e1c80cc5a06de38b165',
      status: 'block'
    };
    const result = await makeRequest('POST', '/v1/issuing/cards/status', body);

    console.log(result);
  } catch (error) {
    console.error('Error completing request', error);
  }
}

PHP

<?php
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/code_race_2020/Utilities/PHP/utilities.php";
include($path);
$body = [
    "card" => "card_f8dd3aa099444e1c80cc5a06de38b165",
        "status" => "block"
];
try {
    $object = make_request('post', '/v1/issuing/cards/status', $body);
    var_dump($object);
} catch(Exception $e) {
    echo "Error: $e";
}
?>

Python

from pprint import pprint

from utilities import make_request

card = {
    "card": "card_f8dd3aa099444e1c80cc5a06de38b165",
    "status": "block"
}

results = make_request(method='post', path=f'/v1/issuing/cards/status', body=card)
pprint(results)

/v1/issuing/cards/status

Update Card Status by Card ID

curl -X post
'https://sandboxapi.rapyd.net/v1/issuing/cards/status' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'idempotency: your-idempotency-parameter-here' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here' \
--data-raw '{
	"card": "card_a5429bdb6c529008ed5b409e5929b606",
	"status": "block",
        "block_reason_code": "CAN",
        "card_status_initiator": "CAH"
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "c6762dab-f31b-4bd2-a47e-abd4e1a12bcd"
    },
    "data": {
        "id": "ci_0b164db21d9c513e2b9d2dac77a3014a",
        "ewallet_contact": {
            "id": "cont_cb60ec28c2f0bdfc621cfc21270c20ce",
            "first_name": "John",
            "last_name": "Doe",
            "middle_name": "",
            "second_last_name": "",
            "gender": "not_applicable",
            "marital_status": "not_applicable",
            "house_type": "",
            "contact_type": "personal",
            "phone_number": "+14155551237",
            "email": "",
            "identification_type": "",
            "identification_number": "",
            "issued_card_data": {
                "preferred_name": "",
                "transaction_permissions": "",
                "role_in_company": ""
            },
            "date_of_birth": "2000-12-15",
            "country": "NG",
            "nationality": null,
            "address": {
                "id": "address_8dc883799f2fcb5adb92bf77b6bc85b7",
                "name": "John Doe",
                "line_1": "123 Main Street",
                "line_2": "",
                "line_3": "",
                "city": "Anytown",
                "state": "",
                "country": "",
                "zip": "",
                "phone_number": "",
                "metadata": {},
                "canton": "",
                "district": "",
                "created_at": 1755679320
            },
            "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
            "created_at": 1612104554,
            "metadata": {},
            "business_details": null,
            "compliance_profile": 0,
            "verification_status": "not verified",
            "send_notifications": false,
            "mothers_name": ""
        },
        "status": "BLO",
        "card_id": "card_a5429bdb6c529008ed5b409e5929b606",
        "assigned_at": 1760012427,
        "activated_at": 1760012450,
        "metadata": {},
        "country_iso_alpha_2": "BR",
        "created_at": 1760012427,
        "blocked_reason": "canceled",
        "blocked_reason_code": "CAN",
        "blocked_reason_desc": "canceled",
        "card_status_initiator": "CAH",
        "card_status_initiator_desc": "cardholder",         
        "card_tracking_id": null,
        "card_program": "cardprog_b027c85a66ebebb2e094bca626d5ae97",
        "public_details": {
            "bin": "517413",
            "last4": "3157",
            "sub_bin": "76",
            "expiration": "1028"
        }
    }
}

Update Card Status by Card Number

curl -X post
'https://sandboxapi.rapyd.net/v1/issuing/cards/status' \
-H 'access_key: your-access-key-here' \
-H 'Content-Type: application/json' \
-H 'idempotency: your-idempotency-parameter-here' \
-H 'salt: your-random-string-here' \
-H 'signature: your-calculated-signature-here' \
-H 'timestamp: your-unix-timestamp-here' \
--data-raw '{
	"card": "5348330641217634",
	"status": "block",
        "block_reason_code": "CAN",
        "card_status_initiator": "CAH"
}'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "2bdd6303-cedf-4450-822d-c8be6b5b123a"
    },
    "data": {
        "id": "ci_d4fa9d7f43819d92c66125e2a7579fe6",
        "ewallet_contact": {
            "id": "cont_cb60ec28c2f0bdfc621cfc21270c20ce",
            "first_name": "John",
            "last_name": "Doe",
            "middle_name": "",
            "second_last_name": "",
            "gender": "not_applicable",
            "marital_status": "not_applicable",
            "house_type": "",
            "contact_type": "personal",
            "phone_number": "+14155551237",
            "email": "",
            "identification_type": "",
            "identification_number": "",
            "issued_card_data": {
                "preferred_name": "",
                "transaction_permissions": "",
                "role_in_company": ""
            },
            "date_of_birth": "2000-12-15",
            "country": "NG",
            "nationality": null,
            "address": {
                "id": "address_8dc883799f2fcb5adb92bf77b6bc85b7",
                "name": "John Doe",
                "line_1": "123 Main Street",
                "line_2": "",
                "line_3": "",
                "city": "Anytown",
                "state": "",
                "country": "",
                "zip": "",
                "phone_number": "",
                "metadata": {},
                "canton": "",
                "district": "",
                "created_at": 1755679320
            },
            "ewallet": "ewallet_3801e782955b29955445586a2405a5db",
            "created_at": 1612104554,
            "metadata": {},
            "business_details": null,
            "compliance_profile": 0,
            "verification_status": "not verified",
            "send_notifications": false,
            "mothers_name": ""
        },
        "status": "BLO",
        "card_id": "card_0393b8437d759c5fb491d427b0000322",
        "assigned_at": 1760011681,
        "activated_at": 1760012238,
        "metadata": {},
        "country_iso_alpha_2": "BR",
        "created_at": 1760011681,
        "blocked_reason": "canceled",
        "blocked_reason_code": "CAN",
        "blocked_reason_desc": "canceled",
        "card_status_initiator": "CAH",
        "card_status_initiator_desc": "cardholder",
        "card_tracking_id": null,
        "card_program": "cardprog_b027c85a66ebebb2e094bca626d5ae97",
        "public_details": {
            "bin": "534833",
            "last4": "7634",
            "sub_bin": "64",
            "expiration": "1028"
        }
    }
}

En esta sección:

Documentación