Skip to main content

Documentation

Group Payment

Collects money from multiple payment methods.

A group payment consolidates 2 to 10 individual payments into a single transaction.

Note

  • The individual payments must all be supported in the same country and must use the same currency.

  • A single payment method can appear only one time in a single group payment.

  • A customer who has multiple payment methods can use each of them up to one time in a single group payment.

  • If a payment fails, you can add another one to the group payment using Create Payment. Set group_payment to the ID of the relevant group payment. The total amount of all payments that have not failed must be equal to or less than the amount of the group payment.

  • You can refund all or part of a group payment. A partial refund is apportioned among all the payments according to their percentage of the total amount.

  • Group payments do not support FX.

  • Group payments do not support escrows.

  • A group payment can be canceled if the status of all payments is ERR or ACT.

  • A group payment can be refunded if the status of all payments is CLO.

Methods - Group Payment

Group Payment Webhooks

Group Payment Error Messages