Update Payment

PUT /rest/merchants/{MID}/groups/{GroupID}/payments/{PaymentID}

Description: Updates the mutable fields of a specific scheduled payment. This is a full replacement (PUT) — provide all required fields. The sendPaymentScheduledNotification field is immutable after creation and cannot be changed.

sendPaymentScheduledNotification is immutable. Do not include a changed value for this field. Attempting to change it will return a 400 Bad Request with an ImmutableFieldViolation error message.

Transactions alias: Also accessible at PUT /rest/merchants/{MID}/groups/{GroupID}/transactions/{TransactionID}.

Path Parameters

MID (required)

Type: string — 8 or 11 digits

Example: 32350000576

GroupID (required)

Type: string (UUID)

Example: 01234567-abcd-1234-9876-abcdef123456

PaymentID (required)

Type: string (UUID)

Example: aaaaaaaa-1111-2222-3333-444444444444

Request Body

Field	Type	Required	Description
`paymentId`	string (UUID)	Required	Must match `PaymentID` in the path.
`paymentGroupId`	string (UUID)	Required	Must match `GroupID` in the path.
`profileId`	string	Required	Tokenized payment method: `[ProfileID]/[AccountID]`.
`amount`	number	Required	Updated payment amount.
`orderId`	string	Optional	External order reference.
`recurring`	boolean	Optional	Whether part of a recurring series. Default: `false`.
`allowPartial`	boolean	Optional	Allow partial authorization.
`sendEmailReceipt`	boolean	Optional	Send receipt after settlement. Default: `false`. Can be updated.
`sendPaymentScheduledNotification`	boolean	Optional	Read-only after creation. Do not change.
`customAttributes`	object	Optional	Integrator key-value pairs.
`fees`	array	Optional	Fee objects.

Example Request

PUT /rest/merchants/32350000576/groups/01234567-abcd-1234-9876-abcdef123456/payments/aaaaaaaa-1111-2222-3333-444444444444
Authorization: Bearer <token>
Content-Type: application/json

{
  "paymentId": "aaaaaaaa-1111-2222-3333-444444444444",
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 150.00,
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "customAttributes": { "studentId": "STU-101" }
}

Responses

200 OK

{
  "paymentId": "aaaaaaaa-1111-2222-3333-444444444444",
  "paymentGroupId": "01234567-abcd-1234-9876-abcdef123456",
  "profileId": "5380083609111899173/5274056435998490280",
  "amount": 150.00,
  "deleted": false,
  "sendEmailReceipt": true,
  "sendPaymentScheduledNotification": true,
  "dateCreated": "2025-06-01T14:30:00Z",
  "lastUpdated": "2025-06-02T12:00:00Z",
  "customAttributes": { "studentId": "STU-101" },
  "authResponse": null
}

Error Responses

Status	Meaning
400	Validation error — missing required fields, invalid values, or attempt to change `sendPaymentScheduledNotification`.
401	Missing or expired bearer token.
404	Payment not found or does not belong to this merchant/group.
500	Unexpected server error.