Create Group Refund

POST {{baseUrl}}/v1/refunds/group_payments

Refund a group payment when the status of the group payment is closed. The refund is credited against a specific group payment. The money is returned to the payment methods that were used for the payment. If the action of a third party is not required, this method triggers the Refund Completed webhook for each payment method.

Request Body

{"group_payment"=>"<string>", "amount"=>"<number>"}

HEADERS

RESPONSES

status: OK

{"data":{"amount":"\u003cnumber\u003e","amount_to_replace":"\u003cnumber\u003e","cancel_reason":"\u003cstring\u003e","country":"\u003cstring\u003e","currency":"\u003cstring\u003e","description":"\u003cstring\u003e","expiration":"\u003cnumber\u003e","id":"\u003cstring\u003e","merchant_reference_id":"\u003cstring\u003e","metadata":{},"payments":[{"address":{"canton":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"SG","created_at":"\u003cnumber\u003e","district":"\u003cstring\u003e","id":"\u003cstring\u003e","line_1":"\u003cstring\u003e","line_2":"\u003cstring\u003e","line_3":"\u003cstring\u003e","metadata":{},"name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e"},"amount":0,"auth_code":"\u003cstring\u003e","cancel_reason":"\u003cstring\u003e","captured":true,"complete_payment_url":"\u003cstring\u003e","country_code":"KP","created_at":"\u003cinteger\u003e","currency_code":"XAF","customer_token":"\u003cstring\u003e","description":"\u003cstring\u003e","dispute":{"id":"\u003cstring\u003e","token":"\u003cstring\u003e","status":"ARB","amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e","dispute_category":"\u003cstring\u003e","dispute_reason_description":"\u003cstring\u003e","original_transaction_currency":"XPF","original_transaction_amount":"\u003cnumber\u003e","original_dispute_amount":"\u003cnumber\u003e","original_dispute_currency":"ETB","original_transaction_id":"\u003cstring\u003e","ewallet_id":"\u003cstring\u003e","central_processing_date":"\u003cnumber\u003e","created_at":"\u003cnumber\u003e","updated_at":"\u003cnumber\u003e","due_date":"\u003cnumber\u003e","payment_method":"\u003cstring\u003e","payment_method_data":{},"rate":"\u003cnumber\u003e","evidence":"\u003cstring\u003e","evidence_reason_code":"\u003cstring\u003e","pre_dispute":"\u003cboolean\u003e","arn":"\u003cstring\u003e"},"error_code":"\u003cstring\u003e","error_payment_url":"\u003cstring\u003e","escrow":{},"ewallet_id":"\u003cstring\u003e","ewallets":[{"ewallet_id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","percent":"\u003cnumber\u003e","refunded_amount":"\u003cnumber\u003e"}],"expiration":0,"failure_code":"\u003cstring\u003e","failure_message":"\u003cstring\u003e","fixed_side":"\u003cstring\u003e","flow_type":"\u003cstring\u003e","fx_rate":1,"group_payment":"\u003cstring\u003e","id":"\u003cstring\u003e","initiation_type":"\u003cstring\u003e","instructions":[{"name":"\u003cstring\u003e","steps":[{"step":"\u003cstring\u003e"}]}],"invoice":"\u003cstring\u003e","is_partial":false,"merchant_reference_id":"\u003cstring\u003e","merchant_requested_amount":"\u003cstring\u003e","merchant_requested_currency":"\u003cstring\u003e","metadata":{},"mid":"\u003cstring\u003e","next_action":"not_applicable","order":"\u003cstring\u003e","original_amount":0,"outcome":{"network_status":"approved_by_network","payment_flow_type":"ewallet_payout","payment_options":{"address":{"canton":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"KG","created_at":"\u003cnumber\u003e","district":"\u003cstring\u003e","id":"\u003cstring\u003e","line_1":"\u003cstring\u003e","line_2":"\u003cstring\u003e","line_3":"\u003cstring\u003e","metadata":{},"name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e"},"amount_range_per_currency":[{"maximum_amount":"\u003cnumber\u003e","minimum_amount":"\u003cnumber\u003e","currency":"KZT"}],"bin_details":{"brand":"\u003cstring\u003e","bin_number":"\u003cstring\u003e","type":"\u003cstring\u003e","issuer":"\u003cstring\u003e","country":"VI","level":"\u003cstring\u003e"},"category":"cash","conditions":[{"description":"\u003cstring\u003e","element_name":"\u003cstring\u003e","operator":"\u003cstring\u003e","threshold_value":"\u003cstring\u003e"}],"country":"CU","currencies":["CRC"],"customer":{"name":"\u003cstring\u003e","addresses":[{"canton":"\u003cstring\u003e","city":"\u003cstring\u003e","country":"LU","created_at":"\u003cnumber\u003e","district":"\u003cstring\u003e","id":"\u003cstring\u003e","line_1":"\u003cstring\u003e","line_2":"\u003cstring\u003e","line_3":"\u003cstring\u003e","metadata":{},"name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","state":"\u003cstring\u003e","zip":"\u003cstring\u003e"}],"business_vat_id":"\u003cstring\u003e","created_at":"\u003cinteger\u003e","default_payment_method":"\u003cstring\u003e","delinquent":"\u003cboolean\u003e","description":"\u003cstring\u003e","discount":{"coupon":{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"DZD","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"forever","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":47,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},"customer":"\u003cstring\u003e","end":"\u003cnumber\u003e","id":"\u003cstring\u003e","number_of_uses":"\u003cnumber\u003e","start":"\u003cnumber\u003e","subscription":"\u003cstring\u003e","valid":"\u003cboolean\u003e"},"email":"\u003cstring\u003e","ewallet":"\u003cstring\u003e","id":"\u003cstring\u003e","invoice_prefix":"\u003cstring\u003e","metadata":{},"payment_methods":{"data":[{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","category":"ewallet","metadata":{},"image":"\u003cstring\u003e","webhook_url":"\u003cstring\u003e","supporting_documentation":"\u003cstring\u003e","next_action":"pending_confirmation","bic_swift":"\u003cstring\u003e","account_last4":"\u003cstring\u003e"}],"has_more":"\u003cboolean\u003e","total_count":"\u003cinteger\u003e","url":"\u003cstring\u003e"},"phone_number":"\u003cstring\u003e","subscriptions":[{"billing":"\u003cstring\u003e","billing_cycle_anchor":"\u003cstring\u003e","cancel_at_period_end":"\u003cboolean\u003e","canceled_at":"\u003cnumber\u003e","created_at":"\u003cnumber\u003e","current_period_end":"\u003cnumber\u003e","current_period_start":"\u003cnumber\u003e","customer_token":"\u003cstring\u003e","days_until_due":"\u003cnumber\u003e","discount":{"coupon":{"amount_off":"\u003cnumber\u003e","created":"\u003cnumber\u003e","currency":"TOP","description":"\u003cstring\u003e","discount_duration_in_uses":"\u003cnumber\u003e","discount_valid_until":"\u003cnumber\u003e","discount_validity_in_months":"\u003cnumber\u003e","duration":"repeating","duration_in_months":"\u003cnumber\u003e","id":"\u003cstring\u003e","max_redemptions":"\u003cnumber\u003e","metadata":{},"percent_off":8,"redeem_by":"\u003cnumber\u003e","times_redeemed":"\u003cnumber\u003e","valid":"\u003cboolean\u003e"},"end":"\u003cnumber\u003e","id":"\u003cstring\u003e","number_of_uses":"\u003cnumber\u003e","start":"\u003cnumber\u003e","subscription":"\u003cstring\u003e","valid":"\u003cboolean\u003e"},"ended_at":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"payment_fields":{},"payment_method":"\u003cstring\u003e","payout_fields":{},"simultaneous_invoice":"\u003cboolean\u003e","status":"unpaid","subscription_items":{"data":[{"created":"\u003cnumber\u003e","id":"\u003cstring\u003e","metadata":{},"plan":{"active":"\u003cboolean\u003e","aggregate_usage":"last_during_period","amount":"\u003cnumber\u003e","billing_scheme":"per_unit","created_at":"\u003cnumber\u003e","currency":"JMD","id":"\u003cstring\u003e","interval":"week","interval_count":"\u003cnumber\u003e","metadata":{},"nickname":"\u003cstring\u003e","product":{"active":"\u003cboolean\u003e","attributes":["\u003cstring\u003e"],"created_at":"\u003cnumber\u003e","description":"\u003cstring\u003e","id":"\u003cstring\u003e","images":["\u003cstring\u003e"],"metadata":{},"name":"\u003cstring\u003e","package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"shippable":"\u003cboolean\u003e","skus":[{"active":"\u003cboolean\u003e","attributes":{},"created_at":"\u003cnumber\u003e","currency":"UZS","id":"\u003cstring\u003e","image":"\u003cstring\u003e","inventory":{},"metadata":{},"package_dimensions":{"height":"\u003cnumber\u003e","length":"\u003cnumber\u003e","weight":"\u003cnumber\u003e","width":"\u003cnumber\u003e"},"price":"\u003cnumber\u003e","product":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"}],"statement_descriptor":"\u003cstring\u003e","type":"goods","unit_label":"\u003cstring\u003e","updated_at":"\u003cnumber\u003e"},"tiers":[{"amount":"\u003cnumber\u003e","flat_amount":"\u003cnumber\u003e","up_to":"\u003cstring\u003e"}],"tiers_mode":"volume","transform_usage":{"divide_by":"\u003cnumber\u003e","round":"\u003cstring\u003e"},"trial_period_days":"\u003cnumber\u003e","usage_type":"metered"},"quantity":"\u003cnumber\u003e","subscription_id":"\u003cstring\u003e"}],"has_more":"\u003cboolean\u003e","total_count":"\u003cnumber\u003e","url":"\u003cstring\u003e"},"tax_percent":"\u003cnumber\u003e","trial_end":"\u003cnumber\u003e","trial_start":"\u003cnumber\u003e","type":"payout"}]},"fingerprint":"\u003cstring\u003e","image":"\u003cstring\u003e","instructions":"\u003cstring\u003e","is_cancelable":"\u003cboolean\u003e","is_expirable":"\u003cboolean\u003e","is_online":"\u003cboolean\u003e","is_refundable":"\u003cboolean\u003e","is_required":"\u003cboolean\u003e","is_tokenizable":"\u003cboolean\u003e","is_virtual":"\u003cboolean\u003e","last4":"8550","maximum_expiration_seconds":"\u003cinteger\u003e","minimum_expiration_seconds":"\u003cinteger\u003e","multiple_overage_allowed":"\u003cboolean\u003e","name":"\u003cstring\u003e","payment_flow_type":"ewallet_payout"},"status":"\u003cstring\u003e","risk_level":"not_assessed","seller_message":"\u003cstring\u003e"},"paid":false,"paid_at":0,"payment_fees":{"fx_fee":{"calc_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"},"gross_fees":"\u003cnumber\u003e","net_fees":"\u003cnumber\u003e","transaction_fee":{"calc_type":"\u003cstring\u003e","fee_type":"\u003cstring\u003e","value":"\u003cnumber\u003e"}},"payment_method":"\u003cstring\u003e","payment_method_data":{},"payment_method_options":{},"payment_method_type":"\u003cstring\u003e","payment_method_type_category":"ewallet","receipt_email":"\u003cstring\u003e","receipt_number":"\u003cstring\u003e","redirect_url":"\u003cstring\u003e","refunded":false,"refunded_amount":0,"refunds":{"data":["\u003cstring\u003e"],"has_more":"\u003cboolean\u003e","total_count":"\u003cinteger\u003e","url":"\u003cstring\u003e"},"remitter_information":{},"save_payment_method":"\u003cboolean\u003e","statement_descriptor":"\u003cstring\u003e","status":"ACT","textual_codes":{},"transaction_id":"\u003cstring\u003e","visual_codes":{}}],"status":"\u003cstring\u003e"},"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"}}