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'
    -d '{
        "card_id": "card_5e932d89be218e5d6a5ec20daa156466",
        "blocked_reason": "canceled"
    }
    '
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "6e40963f-ab7b-40df-b837-9f625a305922"
        },
        "data": {
            "id": "ci_85856f34805b5b4eb7981d9619312272",
            "ewallet_contact": {
                "id": "cont_3625cb4fc18d005b12f9ccf0c466755e",
                "first_name": "John",
                "last_name": "Doe",
                "middle_name": "",
                "second_last_name": "",
                "gender": "not_applicable",
                "marital_status": "not_applicable",
                "house_type": "",
                "contact_type": "business",
                "phone_number": "+14155551234",
                "email": "johndoefourstar@rapyd.net",
                "identification_type": "PA",
                "identification_number": "1234567890",
                "issued_card_data": {
                    "preferred_name": "",
                    "transaction_permissions": "",
                    "role_in_company": ""
                },
                "date_of_birth": "2000-11-22",
                "country": "US",
                "nationality": "NL",
                "address": {
                    "id": "address_9706af91b503c70a819605222afabc96",
                    "name": "John Doe - Four Star Professional Services",
                    "line_1": "123 Main Street",
                    "line_2": "",
                    "line_3": "",
                    "city": "Anytown",
                    "state": "NY",
                    "country": "US",
                    "zip": "12345",
                    "phone_number": "+14155551234",
                    "metadata": {},
                    "canton": "",
                    "district": "",
                    "created_at": 1608023967
                },
                "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
                "created_at": 1608023967,
                "metadata": {},
                "business_details": {
                    "id": "busi_9d2952408ec5dec780f5b88a8fc174aa",
                    "name": "Four Star Professional Services",
                    "registration_number": "R24032020000",
                    "entity_type": "company",
                    "industry_category": "company",
                    "industry_sub_category": "home services",
                    "address": {
                        "id": "address_977b39b4b725fadc9040e1ee1e5df795",
                        "name": "John Doe - Four Star Professional Services",
                        "line_1": "1234 Main Street",
                        "line_2": "Suite 1200",
                        "line_3": "",
                        "city": "Anytown",
                        "state": "NY",
                        "country": "US",
                        "zip": "10101",
                        "phone_number": "14155557779",
                        "metadata": {
                            "merchant_defined": true
                        },
                        "canton": "",
                        "district": "",
                        "created_at": 1608023967
                    },
                    "created_at": 1608023967,
                    "annual_revenue": 0,
                    "establishment_date": null,
                    "legal_entity_type": null,
                    "cnae_code": null
                },
                "compliance_profile": 0,
                "verification_status": "not verified",
                "send_notifications": false,
                "mothers_name": "Jane Smith"
            },
            "status": "BLO",
            "card_id": "card_5e932d89be218e5d6a5ec20daa156466",
            "assigned_at": 1626307673,
            "activated_at": 1634648825,
            "metadata": {},
            "country_iso_alpha_2": "US",
            "created_at": 1626307673,
            "blocked_reason": "canceled",
            "card_tracking_id": null,
            "card_program": null,
            "card_number": "5484389609326310",
            "cvv": "947",
            "expiration_month": "07",
            "expiration_year": "24",
            "bin": "548438",
            "sub_bin": "60"
        }
    }