Skip to main content

Input fields

balanceThreshold : Int! required

The ledger balance (in the minor currency unit) which when passed will trigger a payment to be taken.

targetBalance : Int

The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero.

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

{ "balanceThreshold": 38, "targetBalance": 17 }