Skip to main content

Documentation

Simulate Blocking a Card

Simulate a third-party stop notice for an issued card.

Relevant to the sandbox.

Rapyd sets the card status to BLO (blocked) and sends you the Card Issuing Blocked Webhook.

To unblock the card, see Update Card Status.

Prerequisites:

    • blocked_reason

    • Reason for blocking the card.

    • card_id

    • ID of the card. String starting with card_.

  • /v1/issuing/cards/simulate_block

  • Block Card

  • curl -X post 'https://sandboxapi.rapyd.net/v1/issuing/cards/simulate_block' \
    -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_id": "card_bca4712d954a8a1d8673e3eab5db4afd",
        "blocked_reason": "canceled"
    }'
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "fc16597a-c3db-4e6f-a873-dfa7576aeed4"
        },
        "data": {
            "id": "ci_95844411d26acdce273bcdd2fab28fe0",
            "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_bca4712d954a8a1d8673e3eab5db4afd",
            "assigned_at": 1763996148,
            "activated_at": 1763996177,
            "metadata": {},
            "country_iso_alpha_2": "BR",
            "created_at": 1763996149,
            "blocked_reason": "canceled",
            "card_tracking_id": null,
            "card_program": "cardprog_b027c85a66ebebb2e094bca626d5ae97",
            "public_details": {
                "bin": "517413",
                "last4": "3157",
                "sub_bin": "76",
                "expiration": "1128"
            },
            "card_number": "5174137762773157",
            "cvv": "339",
            "expiration_month": "11",
            "expiration_year": "28",
            "bin": "517413",
            "sub_bin": "76"
        }
    }
  • Bad Request - Card Already Blocked

  • curl -X post 'https://sandboxapi.rapyd.net/v1/issuing/cards/simulate_block' \
    -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_id": "card_0393b8437d759c5fb491d427b0000322",
        "blocked_reason": "canceled"
    }'
  • {
        "status": {
            "error_code": "INVALID_ISSUED_CARD_CHANGE_STATUS",
            "status": "ERROR",
            "message": "The request tried to change the status of a card, but the card was not active or the card is already in the indicated status. The request was rejected. Corrective action: 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'.",
            "response_code": "INVALID_ISSUED_CARD_CHANGE_STATUS",
            "operation_id": "0d0f7842-4385-4a76-b369-2d6b16e2ccdd"
        }
    }
  • Bad Request - Card Not Found

  • curl -X post 'https://sandboxapi.rapyd.net/v1/issuing/cards/simulate_block' \
    -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_id": "card_0393b8437d759c5fb491d427b000032",
        "blocked_reason": "canceled"
    }'
  • {
        "status": {
            "error_code": "ERROR_CARD_NOT_FOUND",
            "status": "ERROR",
            "message": "The request attempted to retrieve data on a non-existent card or a card that is not linked to your account. The request was rejected. Corrective action: Check the card token and rerun the request with the correct card details.",
            "response_code": "ERROR_CARD_NOT_FOUND",
            "operation_id": "bd732710-fab3-41c2-98f5-bed176e55d9b"
        }
    }