Skip to main content

Fields

amount : BigInt! required

Amount of payment in the currency's minor unit

id : ID

The ID of the payment.

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.
paymentDate : Date! required

The date this payment is scheduled to be debited

paymentInstruction : PaymentInstructionType

The payment instruction that was used to make this payment.

reference : String! required

The current status of the payment.

surchargeAmount : Int

Surcharge amount generated by this payment.

The transaction type of the payment.

uuid : UUID! required
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": 1, "paymentDate": "1994-10-29", "paymentInstruction": PaymentInstructionType, "reference": "again-physical-paper-structure-deal", "status": "SCHEDULED", "surchargeAmount": 37, "transactionType": "DD_FIRST_COLLECTION", "uuid": "45f21e94-3350-42dc-8ad6-c1c425fe3a18" }