Get All Payments in a Group

GET /rest/merchants/{MID}/groups/{GroupID}/payments

Description: Returns all scheduled payments that belong to the specified group. Each payment includes its current state, including authorization response details if the group has already been processed.

Transactions alias: This endpoint is functionally identical to GET /rest/merchants/{MID}/groups/{GroupID}/transactions. Both paths are supported.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Example: 01234567-abcd-1234-9876-abcdef123456

Query Parameters

Parameter	Type	Required	Description
`pageNumber`	integer ≥ 1	Optional	1-based page number for paginated results.
`pageSize`	integer ≥ 1	Optional	Number of items per page.

Example Request

GET /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456/payments
Authorization: Bearer <token>

Responses

200 OK — Unpaged

[
  {
    "paymentId": "aaaaaaaa-1111-2222-3333-444444444444",
    "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
    "profileId": "5380083609111899173/5274056435998490280",
    "amount": 125.00,
    "deleted": false,
    "orderId": "INV-2030-001",
    "recurring": false,
    "allowPartial": false,
    "sendEmailReceipt": true,
    "sendPaymentScheduledNotification": true,
    "dateCreated": "2025-06-01T14:30:00Z",
    "lastUpdated": "2025-06-01T14:30:00Z",
    "authResponse": null
  },
  {
    "paymentId": "bbbbbbbb-5555-6666-7777-888888888888",
    "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
    "profileId": "9876543210987654321/1234567890123456789",
    "amount": 75.50,
    "deleted": false,
    "sendEmailReceipt": false,
    "sendPaymentScheduledNotification": false,
    "authResponse": {
      "retref": 987654321098,
      "respcode": "00",
      "respstat": "A",
      "resptext": "Approval",
      "amount": 75.50,
      "lastFour": "4242",
      "accountType": "VISA"
    }
  }
]

Error Responses

Status	Meaning
400	Invalid path parameter format.
401	Missing or expired bearer token.
500	Unexpected server error.

Payment Response Fields

Field	Type	Description
`paymentId`	string (UUID)	Unique payment identifier.
`paymentGroupId`	string (UUID)	Parent group ID.
`profileId`	string	Tokenized payment method: `[ProfileID]/[AccountID]`.
`amount`	number	Scheduled payment amount.
`deleted`	boolean	Whether this payment is soft-deleted.
`orderId`	string	External order reference, if set.
`recurring`	boolean	Whether this is part of a recurring series.
`allowPartial`	boolean	Whether partial authorization is allowed.
`sendEmailReceipt`	boolean	Send receipt after settlement (updatable).
`sendPaymentScheduledNotification`	boolean	Sent notification at scheduling time (immutable).
`customAttributes`	object	Integrator key-value pairs.
`fees`	array	Associated fee objects.
`authResponse`	object	Gateway auth response (null until processed).
`voidOrRefundResponses`	array	Void/refund response history.