The Rapyd Client Portal Developer Hub

Welcome to the Rapyd Client Portal developer hub. You'll find comprehensive guides and documentation to help you start working with Rapyd Client Portal as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Listing Group Payments

You can view a list of all group payments.

How to View All Group Payments

  1. Sign in as described in Accessing the Client Portal and navigate to Collect > Group Payments.
    The Group Payments page appears.
  1. Modify the display by doing the following:
  • To add or remove columns, click the Choose Columns icon at the top right. The icon has three vertical bars. On the Choose Columns panel, select the columns you want to appear on screen and click Apply.
  • To change the column order, grab a column header and drag it to a new position.
  • To sort the list, hover over a column header. If the cursor turns into a pointing finger, click the header. An arrow indicates the sort direction. To change the direction, click the header again.
  1. Other things you can do:
  • To filter the list, click the Search field at the top. Suggested filters appear. Select a filter and type a value, or type a free text string. Then click the magnifying glass icon.
  • To clear a filter, delete the text in the Search field and click the magnifying glass icon.
  • To apply an advanced filter, click the Filter icon at the top right. In the Filter window, select a field and a condition, and enter a value. To define an additional filter, click + Add Filter and fill in the field, condition, and value. Then click Apply.
  • To clear an advanced filter, close the filter description.
  • To clear all advanced filters, click Clear All.
  • To view additional columns, move the horizontal scroll bar at the bottom of the page.
  • To scroll through the lines of the table, move the vertical scroll bar at the right side of the page.

Description of Fields

The following table describes the fields in the Group Payments page:



Group Payment ID

ID of the 'group payment' object.

Created at

The time that the group payment was created.


A text description of the group payment.

Expiration Date

End of the time allowed for customers to make this payment.

Merchant Reference ID

The merchant-defined ID.


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 pending.
* canceled - The group payment was canceled.
* closed - All payments in the group payment are complete.

Updated 29 days ago

What's Next

Listing Escrows

Listing Group Payments

You can view a list of all group payments.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.