Skip to main content

Fields

amount : Int

The amount of the payment in pence.

id : ID

The payment's id.

Deprecation
The 'id' field is deprecated.

Please use uuid instead.

- Marked as deprecated on 2026-05-28.
- Scheduled for removal on or after 2027-05-28.
isAmendable : Boolean

Whether or not the payment can be amended.

isCancelled : Boolean

Whether or not the payment has been cancelled.

paymentDate : Date

The date that the payment was/will be made.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "amount": 30, "isAmendable": true, "isCancelled": true, "paymentDate": "2010-09-04", "uuid": "c2fea5e3-e4be-4abf-a7c3-466779c934f0" }