Skip to main content

Documentation

Simulating Quarantine Under Review Webhook

Trigger a Quarantine Under Review Webhook in the sandbox.

Create a bank payout to a beneficiary with the following name: John Doe. See Create Payout.

This type of payout triggers the Quarantine Under Review webhook.

    • Create Payout

      • curl -X post
        https://sandboxapi.rapyd.net/v1/payouts
        -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 '{
            "confirm_automatically": "true",
            "beneficiary": {
                "first_name": "John",
                "last_name": "Doe",
                "address": "456 Second Street",
                "email": "jdoe@rapyd.net",
                "country": "GB",
                "city": "Anytown",
                "postcode": "10101",
                "account_number": "BG96611020345678",
                "bank_name": "gb_local_bank",
                "identification_type": "passport",
                "identification_value": "123456789",
                "sort_code": "123225",
                "bic_swift": "IIIGGB22",
                "ach_code": "123456789"
            },
            "beneficiary_country": "GB",
            "beneficiary_entity_type": "individual",
            "description": "Payout - Bank Transfer: Beneficiary/Sender objects",
            "merchant_reference_id": "GHY-1YU-HUJ-POI",
            "ewallet": "ewallet_9bc4ba65f0c4bf9f86d843920525e3a5",
            "payout_amount": "223",
            "payout_currency": "GBP",
            "payout_method_type": "gb_local_bank",
            "sender": {
                "first_name": "Jane",
                "last_name": "Doe",
                "address": "123 First Street",
                "city": "Anytown",
                "state": "NY",
                "date_of_birth": "22/02/1980",
                "postcode": "12345",
                "phonenumber": "621212938122",
                "remitter_account_type": "Individual",
                "source_of_income": "salary",
                "identification_type": "License No",
                "identification_value": "123456789",
                "purpose_code": "ABCDEFGHI",
                "account_number": "123456789",
                "beneficiary_relationship": "client"
            },
            "sender_country": "NL",
            "sender_currency": "USD",
            "sender_entity_type": "individual",
            "statement_descriptor": "GHY* Limited Access 800-123-4567",
            "metadata": {
                "merchant_defined": true
            }
        }
        '
        
    • Response

      • {
            "status": {
                "error_code": "",
                "status": "SUCCESS",
                "message": "",
                "response_code": "",
                "operation_id": "f93e9d57-70db-4177-a203-0daf74fd3568"
            },
            "data": {
                "id": "payout_0e7987911f4131fed2c8132ca378f387",
                "payout_type": "bank",
                "payout_method_type": "gb_local_bank",
                "amount": 223,
                "payout_currency": "GBP",
                "sender_amount": 281.51,
                "sender_currency": "USD",
                "status": "Hold",
                "sender_country": "NL",
                "sender": {
                    "id": "sender_8dc0dd53b017425311b3066a3a85b53e",
                    "last_name": "Doe",
                    "first_name": "Jane",
                    "country": "NL",
                    "entity_type": "individual",
                    "address": "123 First Street",
                    "name": "Jane Doe",
                    "date_of_birth": "22/02/1980",
                    "postcode": "12345",
                    "city": "Anytown",
                    "state": "NY",
                    "account_number": "123456789",
                    "currency": "USD",
                    "identification_type": "License No",
                    "identification_value": "123456789",
                    "purpose_code": "ABCDEFGHI",
                    "beneficiary_relationship": "client",
                    "source_of_income": "salary"
                },
                "beneficiary_country": "GB",
                "beneficiary": {
                    "id": "beneficiary_023925515b8776feee14b15f30f7f0c6",
                    "last_name": "Doe",
                    "first_name": "John",
                    "country": "GB",
                    "entity_type": "individual",
                    "address": "456 Second Street",
                    "name": "John Doe",
                    "postcode": "10101",
                    "city": "Anytown",
                    "account_number": "BG96611020345678",
                    "currency": "GBP",
                    "email": "jdoe@rapyd.net",
                    "identification_type": "passport",
                    "identification_value": "*********",
                    "bank_name": "gb_local_bank",
                    "bic_swift": "IIIGGB22",
                    "sort_code": "123225",
                    "ach_code": "123456789"
                },
                "fx_rate": 0.79215,
                "instructions": [
                    {
                        "name": "instructions",
                        "steps": [
                            {
                                "step1": "The funds will be transferred to the provided account details of the beneficiary."
                            }
                        ]
                    }
                ],
                "ewallets": [
                    {
                        "ewallet_id": "ewallet_9bc4ba65f0c4bf9f86d843920525e3a5",
                        "amount": 281.51,
                        "percent": 100
                    }
                ],
                "metadata": {
                    "merchant_defined": true
                },
                "description": "Payout - Bank Transfer: Beneficiary/Sender objects",
                "created_at": 1708525206,
                "payout_fees": null,
                "expiration": null,
                "merchant_reference_id": "GHY-1YU-HUJ-POI",
                "paid_at": null,
                "identifier_type": null,
                "identifier_value": null,
                "error": null,
                "paid_amount": 0,
                "statement_descriptor": "GHY* Limited Access 800-123-4567",
                "gc_error_code": "NOT_IMPLEMENTED",
                "batch_file": null,
                "estimated_time_of_arrival": null
            }
        }
        
    • Quarantine Under Review Webhook

      • {
            "id": "wh_450b6a22cd66529ec2a721362e4de92d",
            "data": {
                "token": "qm_3c2c4125120dceed8d6a4f6d7289a7ad",
                "limits": null,
                "reason": "rapyd_protect",
                "source": "rapyd_protect",
                "status": "HLD",
                "created_at": 1708525206,
                "error_code": null,
                "updated_at": 1708525206,
                "action_type": "create_payout",
                "resolved_at": 0,
                "target_tokens": ["payout_0e7987911f4131fed2c8132ca378f387"],
                "action_flow_id": "6a0318c2-892e-4556-b100-d9b30e940dc0",
                "duplicated_action_flow_id": null
            },
            "type": "QUARANTINE_UNDER_REVIEW",
            "status": "NEW",
            "created_at": 1708525206,
            "trigger_operation_id": "f93e9d57-70db-4177-a203-0daf74fd3568"
        }