Skip to main content

Documentation

Group Payment Completed Webhook

The GROUP_PAYMENT_COMPLETED webhook is sent when a group_payment object is completed by all payers.

  • Group Payment Completed Webhook

  • {
        "id": "wh_e0af991a93bc0b173fa6f29149107ea7",
        "data": {
            "id": "gp_89aedef8594241094a94685dcde3707b",
            "amount": 1050,
            "status": "closed",
            "country": "US",
            "currency": "USD",
            "metadata": {
                "merchant_defined": true
            },
            "payments": [{
                    "id": "payment_9aa5c53b69114517b1e20ce4ba9eedd3",
                    "mid": "",
                    "paid": true,
                    "order": null,
                    "amount": 25,
                    "escrow": null,
                    "status": "CLO",
                    "address": null,
                    "dispute": null,
                    "fx_rate": 1,
                    "invoice": "",
                    "outcome": null,
                    "paid_at": 1641214597,
                    "refunds": null,
                    "captured": true,
                    "ewallets": [{
                            "amount": 25,
                            "percent": 100,
                            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                            "refunded_amount": 0
                        }
                    ],
                    "metadata": {},
                    "refunded": false,
                    "flow_type": "",
                    "created_at": 1641214597,
                    "error_code": "",
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "expiration": 1641819397,
                    "fixed_side": "",
                    "is_partial": false,
                    "description": "",
                    "next_action": "not_applicable",
                    "country_code": "US",
                    "failure_code": "",
                    "instructions": [],
                    "payment_fees": null,
                    "redirect_url": "",
                    "visual_codes": {},
                    "cancel_reason": null,
                    "currency_code": "USD",
                    "group_payment": "gp_89aedef8594241094a94685dcde3707b",
                    "receipt_email": "",
                    "textual_codes": {},
                    "customer_token": "cus_4a5e278ce40d99a8f4cd9275593c675b",
                    "payment_method": "card_263e6ea7d8742ace8f57bb57caed7e9c",
                    "receipt_number": "",
                    "transaction_id": "",
                    "failure_message": "",
                    "initiation_type": "customer_present",
                    "original_amount": 25,
                    "refunded_amount": 0,
                    "error_payment_url": "",
                    "payment_method_data": {
                        "id": "card_263e6ea7d8742ace8f57bb57caed7e9c",
                        "name": "Joe Doe",
                        "type": "us_visa_card",
                        "image": "",
                        "last4": "0000",
                        "category": "card",
                        "metadata": null,
                        "acs_check": "unchecked",
                        "cvv_check": "unchecked",
                        "bin_details": {
                            "type": null,
                            "brand": null,
                            "country": null,
                            "bin_number": "446203"
                        },
                        "next_action": "not_applicable",
                        "webhook_url": "",
                        "expiration_year": "25",
                        "expiration_month": "11",
                        "fingerprint_token": "ocfp_1476e28831f830fb85356e3b61a1ed84",
                        "supporting_documentation": ""
                    },
                    "payment_method_type": "us_visa_card",
                    "complete_payment_url": "",
                    "remitter_information": {},
                    "statement_descriptor": "Rapyd",
                    "merchant_reference_id": "",
                    "payment_method_options": {},
                    "merchant_requested_amount": null,
                    "merchant_requested_currency": null,
                    "payment_method_type_category": "card"
                }, {
                    "id": "payment_8775855f7a472b3a07c5894d2badb532",
                    "mid": "",
                    "paid": true,
                    "order": null,
                    "amount": 1025,
                    "escrow": null,
                    "status": "CLO",
                    "address": null,
                    "dispute": null,
                    "fx_rate": 1,
                    "invoice": "",
                    "outcome": null,
                    "paid_at": 1641215836,
                    "refunds": null,
                    "captured": true,
                    "ewallets": [{
                            "amount": 1025,
                            "percent": 100,
                            "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                            "refunded_amount": 0
                        }
                    ],
                    "metadata": {},
                    "refunded": false,
                    "flow_type": "",
                    "created_at": 1641214597,
                    "error_code": "",
                    "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                    "expiration": 1641819397,
                    "fixed_side": "",
                    "is_partial": false,
                    "description": "",
                    "next_action": "not_applicable",
                    "country_code": "US",
                    "failure_code": "",
                    "instructions": [],
                    "payment_fees": null,
                    "redirect_url": "https://sandboxcheckout.rapyd.net/3ds-payment?token=payment_8775855f7a472b3a07c5894d2badb532",
                    "visual_codes": {},
                    "cancel_reason": null,
                    "currency_code": "USD",
                    "group_payment": "gp_89aedef8594241094a94685dcde3707b",
                    "receipt_email": "",
                    "textual_codes": {},
                    "customer_token": "cus_f6c0c6f52ce70ab15d7c3aee921f6e7d",
                    "payment_method": "card_57fd1cc634d1ee5c0425e1e8afd3b5ce",
                    "receipt_number": "",
                    "transaction_id": "",
                    "failure_message": "",
                    "initiation_type": "customer_present",
                    "original_amount": 1025,
                    "refunded_amount": 0,
                    "error_payment_url": "",
                    "payment_method_data": {
                        "id": "card_57fd1cc634d1ee5c0425e1e8afd3b5ce",
                        "name": "Jon Doe",
                        "type": "us_visa_card",
                        "image": "",
                        "last4": "1111",
                        "category": "card",
                        "metadata": null,
                        "acs_check": "unchecked",
                        "cvv_check": "unchecked",
                        "bin_details": {
                            "type": null,
                            "brand": null,
                            "country": null,
                            "bin_number": "411111"
                        },
                        "next_action": "3d_verification",
                        "webhook_url": "",
                        "expiration_year": "25",
                        "expiration_month": "11",
                        "fingerprint_token": "ocfp_e599f990674473ce6283b245e9ad2467",
                        "supporting_documentation": ""
                    },
                    "payment_method_type": "us_visa_card",
                    "complete_payment_url": "",
                    "remitter_information": {},
                    "statement_descriptor": "Rapyd",
                    "merchant_reference_id": "",
                    "payment_method_options": {},
                    "merchant_requested_amount": null,
                    "merchant_requested_currency": null,
                    "payment_method_type_category": "card"
                }
            ],
            "expiration": null,
            "description": "",
            "cancel_reason": null,
            "amount_to_replace": 0,
            "merchant_reference_id": "12345-69089"
        },
        "type": "GROUP_PAYMENT_COMPLETED",
        "status": "NEW",
        "created_at": 1641215837,
        "extended_timestamp": 1641215837674,
        "trigger_operation_id": "1fc1565f-32cb-40d0-8dfa-7feac55232a8"
    }