Add Payment to Group

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

Description: Creates a new scheduled payment and adds it to the specified group. The payment will be processed at the group's scheduled date and hour.

Prefer batch creation: If you know all payments at group creation time, include them in the POST /groups request body to save API calls. Use this endpoint to add payments to an existing group.

Transactions alias: This endpoint is functionally identical to POST /rest/merchants/{MID}/groups/{GroupID}/transactions.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Example: 01234567-abcd-1234-9876-abcdef123456

Request Body

Field	Type	Required	Description
`paymentGroupId`	string (UUID)	Required	Must match `GroupID` in the path.
`profileId`	string	Required	Tokenized payment method reference: `[ProfileID]/[AccountID]`.
`amount`	number	Required	Scheduled payment amount.
`orderId`	string	Optional	External order or invoice reference.
`recurring`	boolean	Optional	Whether this is part of a recurring series. Default: `false`.
`allowPartial`	boolean	Optional	Allow partial authorization for this payment.
`sendEmailReceipt`	boolean	Optional	Send receipt email after settlement. Default: `false`. Can be updated later via PUT.
`sendPaymentScheduledNotification`	boolean	Optional	Send a scheduling notification email now. Default: `false`. Immutable after creation.
`customAttributes`	object	Optional	Arbitrary key-value pairs for integrator use.
`fees`	array	Optional	Fee objects associated with this payment.

sendPaymentScheduledNotification is immutable. Set this flag correctly at creation time. Attempting to change it via PUT will return a 400 ImmutableFieldViolation error.

Example Request

POST /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456/payments
Authorization: Bearer <token>
Content-Type: application/json

{
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 125.00,
  "orderId": "INV-2030-055",
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "customAttributes": {
    "studentId": "STU-101",
    "invoiceRef": "INV-2030-055"
  }
}

Responses

201 Created

{
  "paymentId": "cccccccc-9999-8888-7777-666666666666",
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 125.00,
  "deleted": false,
  "orderId": "INV-2030-055",
  "recurring": false,
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "dateCreated": "2025-06-02T10:00:00Z",
  "lastUpdated": "2025-06-02T10:00:00Z",
  "customAttributes": {
    "studentId": "STU-101",
    "invoiceRef": "INV-2030-055"
  },
  "authResponse": null
}

Error Responses

Status	Meaning
400	Validation error — missing required fields or invalid values.
401	Missing or expired bearer token.
404	Group not found or does not belong to this merchant.
500	Unexpected server error.