Skip to main content

Documentation

Payment Succeeded Webhook

The PAYMENT_SUCCEEDED webhook is sent when a payment is successfully created. This webhook is also sent when a card payment method type is added to a customer, which triggers a zero-amount payment.

  • PAYMENT_SUCCEEDED Webhook

  • {
        "id": "wh_553e242e4e54ccc75c21b20710df0902",
        "data": {
            "id": "payment_56f3eb8ec543a3962ce112b4f03da9ae",
            "mid": "",
            "paid": false,
            "order": null,
            "amount": 0,
            "escrow": null,
            "status": "ACT",
            "address": null,
            "dispute": null,
            "fx_rate": 1,
            "invoice": "",
            "outcome": null,
            "paid_at": 0,
            "refunds": null,
            "captured": false,
            "ewallets": [{
                    "amount": 10,
                    "percent": 100,
                    "ewallet_id": "ewallet_6a6669f4febd8b2eb9c5d77e7161a679",
                    "refunded_amount": 0
                }
            ],
            "metadata": {},
            "refunded": false,
            "auth_code": null,
            "flow_type": "",
            "created_at": 1689859010,
            "error_code": "",
            "ewallet_id": "ewallet_6a6669f4febd8b2eb9c5d77e7161a679",
            "expiration": 1689859548,
            "fixed_side": "",
            "is_partial": false,
            "description": "testing",
            "next_action": "3d_verification",
            "country_code": "IL",
            "failure_code": "",
            "instructions": [],
            "payment_fees": null,
            "redirect_url": "https://qacheckout.rapyd.net/3ds-payment?token=payment_56f3eb8ec543a3962ce112b4f03da9ae",
            "visual_codes": {},
            "cancel_reason": null,
            "currency_code": "USD",
            "group_payment": "",
            "receipt_email": "",
            "textual_codes": {},
            "customer_token": "cus_0335a29669a3f4337317d6e1441df763",
            "payment_method": "card_27a4c2f05d9ebd1700f5338e155c1ced",
            "receipt_number": "",
            "transaction_id": "",
            "failure_message": "",
            "initiation_type": "customer_present",
            "original_amount": 10,
            "refunded_amount": 0,
            "error_payment_url": "https://support.rapyd.net/hc/en-us",
            "payment_method_data": {
                "id": "card_27a4c2f05d9ebd1700f5338e155c1ced",
                "name": "Auto Test",
                "type": "il_visa_card",
                "image": "",
                "last4": "1111",
                "category": "card",
                "metadata": null,
                "acs_check": "unchecked",
                "cvv_check": "unchecked",
                "bin_details": {
                    "type": "CREDIT",
                    "brand": "VISA",
                    "level": null,
                    "issuer": "JPMORGAN CHASE BANK, N.A.",
                    "country": "US",
                    "bin_number": "411111"
                },
                "next_action": "3d_verification",
                "webhook_url": "",
                "expiration_year": "24",
                "expiration_month": "12",
                "fingerprint_token": "ocfp_11ECFC396977BB4E81220EC01B2F2B1B",
                "supporting_documentation": ""
            },
            "payment_method_type": "il_visa_card",
            "save_payment_method": true,
            "complete_payment_url": "https://www.rapyd.net",
            "remitter_information": {},
            "statement_descriptor": "card_tokenization_with",
            "merchant_reference_id": "",
            "payment_method_options": {
                "3d_required": true
            },
            "merchant_requested_amount": null,
            "merchant_requested_currency": null,
            "payment_method_type_category": "card"
        },
        "type": "PAYMENT_SUCCEEDED",
        "status": "NEW",
        "created_at": 1689859010,
        "trigger_operation_id": "c3d1ac9d-139b-4c55-8da4-b1c32cf88fa9"
    }