--- title: "Group Payment Completed Webhook" source_url: https://docs.rapyd.net/en/group-payment-completed-webhook.html lang: en --- # Group Payment Completed Webhook The **GROUP_PAYMENT_COMPLETED** webhook is sent when a `group_payment` object is completed by all payers. > **Note:** > > The endpoint for webhooks is unique for each client. To set up a webhook endpoint, see [Defining a Webhook Endpoint](https://docs.rapyd.net/en/defining-a-webhook-endpoint.md "Defining a Webhook Endpoint"). ### Parameters ### Webhook Header Parameters - - Content-Type - Indicates that the data appears in JSON format. Set to **application/json**. - - salt - Random string. - - signature - Signature calculated for each webhook individually. See [Webhook Authentication](https://docs.rapyd.net/en/webhook-authentication.md "Webhook Authentication"). - - timestamp - Timestamp for the webhook, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Webhook Root Parameters - - created_at - Time that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). > **Note:** > > Inside the `data` object, some webhooks have another `created_at` field that refers to a different event. - - data - Contains the actual data of the webhook. For details, see below. - - extended_timestamp - Time in milliseconds that the webhook was created, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - id - ID of the webhook. String starting with **wh_**. - - status - Status of the webhook. One of the following: - **NEW** - **CLO** - Closed. - **ERR** - Error. - **RET** - Re-sent. > **Note:** > > Inside the `data` object, some webhooks have another `status` field that refers to a different event. - - trigger_operation_id - ID of the operation that triggered the webhook. UUID. - - type - Name of the webhook type. > **Note:** > > The name in the Client Portal is different. ### Webhook Data Parameters - - amount - Amount of the group payment, in units defined by `currency`. - - amount_to_replace - Indicates the total amount of failed payments that have not been replaced. - - cancel_reason - Reason for cancellation of the group payment. - - country - Country where the payment methods are supported. Two-letter ISO 3166-1 ALPHA-2 code. - - currency - Currency of the payments. Three-letter ISO 4217 code. - - description - Description of the group payment. - - expiration - End of the time allowed for customers to make this payment, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - id - ID of the 'group_payment' object. String starting with **gp_**. - - merchant_reference_id - Identifier defined by the client for reference purposes. Limit: 45 characters. - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - payments - Array of 'payment' objects. All payments must have the same currency and must be supported in the same country. For details of the fields in the 'payment' object, see [Create Payment](https://docs.rapyd.net/en/create-payment.md "Create Payment"). - - reason - Reason for cancellation of the group payment. - - status - Indicates the status of the group payment operation. One of the following values: - **active** - The group payment was created and one or more payments are still open. - **canceled** - The group payment was canceled. - **closed** - All payments in the group payment are complete.Response only. - Group Payment Completed Webhook - ```json { "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" } ```