Skip to main content

Fields

amount : Decimal! required

Full amount in the currency's smallest denomination (e.g. pence for GBP). Deprecated: use amountAsMinorUnits instead.

Deprecation
The 'amount' field is deprecated.

Please use 'amountAsMinorUnits' instead.

- Marked as deprecated on 2026-10-26.
- Scheduled for removal on or after 2027-05-01.
amountAsISO20022 : ISO20022MoneyAmount! required

The amount represented as an ISO 20022 structured value.

amountAsMinorUnits : BigInt! required

The amount in the smallest denomination of the currency (e.g. pence for GBP, cents for USD).

currency : String! required

The ISO-4217 code for the currency. Deprecated: use currencyDetails.iso4217CurrencyCode instead.

Deprecation
The 'currency' field is deprecated.

Please use 'currencyDetails.iso4217CurrencyCode' instead.

- Marked as deprecated on 2026-10-26.
- Scheduled for removal on or after 2027-05-01.
currencyDetails : CurrencyDetails! required

Details about the currency of this amount.

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

{ "amountAsISO20022": ISO20022MoneyAmount, "amountAsMinorUnits": 1, "currencyDetails": CurrencyDetails }