Group Payment Message Sequences
Message sequences for multiple payments in a single transaction.
A group payment consolidates multiple payments into one client transaction. Rapyd processes the individual customer payments in parallel.
A client creates a group payment for two customers paying with cards and both payments succeed.
Group Payment Creation
Customer 1 submits payment information to the client.
Customer 2 submits payment information to the client.
The client sends a Create Group Payment request to Rapyd.
Rapyd sends a response to the client. The status of the payment is set to ACT and the status of the group payment is set to active.
Rapyd sends Payment Succeeded Webhook to the client for customer 1.
Rapyd sends Payment Succeeded Webhook to the client for customer 2.
Group Payment Processing
Rapyd requests a payment from the card network for customer 1.
Rapyd requests a payment from the card network for customer 2.
The card network approves the payment for customer 1 and transfers the funds to Rapyd.
Rapyd credits the client wallet with payment for customer 1 and sends Payment Completed Webhook to the client. The status of the payment is set to CLO.
The card network approves the payment for customer 2 and transfers the funds to Rapyd.
Rapyd credits the client wallet with payment for customer 2 and sends Payment Completed Webhook to the client. The status of the payment is set to CLO.
When all payments have been processed, Rapyd sends Group Payment Completed Webhook to the client. The status of the group payment is set to closed.
A client creates a group payment for two customers paying with cards. The first customer's payment succeeds. The second customer's payment fails, and is re-sent successfully.
Group Payment Creation
Customer 1 submits payment information to the client.
Customer 2 submits payment information to the client.
The client sends a Create Group Payment request to Rapyd.
Rapyd sends a response to the client. The status of the payment is set to ACT and the status of the group payment is set to active.
Rapyd sends Payment Succeeded Webhook to the client for customer 1.
Rapyd sends Payment Succeeded Webhook to the client for customer 2.
Group Payment Processing - Partial Failure
Rapyd requests a payment from the card network for customer 1.
Rapyd requests a payment from the card network for customer 2.
The card network approves the payment for customer 1 and transfers the funds to Rapyd.
Rapyd credits the client wallet with payment for customer 1 and sends Payment Completed Webhook to the client. The status of the payment is set to CLO.
The card network rejects the payment for customer 2.
Rapyd sends Payment Failed Webhook to the client for customer 2. The status of the payment is set to ERR.
Group Payment Processing - Failed Payment Re-sent
The client informs customer 2 that the payment failed.
Customer 2 submits new payment information to the client.
The client sends a Create Payment request to Rapyd for customer 2. The client sets
group_paymentto the ID of the Create Group Payment response.Rapyd sends a response to the client. The status of the payment is set to ACT.
Rapyd sends Payment Succeeded Webhook to the client for customer 2.
Rapyd requests a payment from the card network for customer 2.
The card network approves the payment for customer 2 and transfers the funds to Rapyd.
Rapyd credits the client wallet with payment for customer 2 and sends Payment Completed Webhook to the client. The status of the payment is set to CLO.
Rapyd sends Group Payment Completed Webhook to the client. The status of the group payment is set to closed.