Skip to main content

Input fields

accountNumber : String! required

The account number.

activeFrom : DateTime! required

The start datetime of the agreement.

activeTo : DateTime

The end datetime of the agreement, if any.

amount : Int! required

The amount contributed per interval. Note, this is in the smallest domination that the currency supports. e.g. Pence, Cents, Yen, etc.

interval : Interval! required

The frequency of contributions.

schemeCode : String! required

The code of the scheme to contribute to.

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

{ "accountNumber": "A-E3105531", "activeFrom": "2007-09-06T23:06:44.477839+00:00", "activeTo": "1986-10-02T18:20:48.491922+00:00", "amount": 64, "interval": "MONTHLY", "schemeCode": "admit-partner-I-example-church" }