| Name | Type | Description | Notes |
|---|---|---|---|
| agreement_id | string | The unique ID GOV.UK Pay automatically associated with a recurring payments agreement. Including `agreement_id` in your request tells the API to take this payment using the card details that are associated with this agreement. `agreement_id` must match an active agreement ID. You must set `authorisation_mode` to `agreement` for the API to accept `agreement_id`. | [optional] |
| amount | int | Sets the amount the user will pay, in pence. | |
| authorisation_mode | string | Sets how you intend to authorise the payment. Defaults to `web`. Payments created with `web` mode follow the standard GOV.UK Pay payment journey. Paying users visit the `next_url` in the response to complete their payment. Payments created with `agreement` mode are authorised with an agreement for recurring payments. If you create an `agreement` payment, you must also send an active `agreement_id`. You must not send `return_url`, `email`, or `prefilled_cardholder_details` or your request will fail. Payments created with `moto_api` mode return an `auth_url_post` object and a `one_time_token`. You can use `auth_url_post` and `one_time_token` to send the paying user’s card details through the API and complete the payment. If you create a `moto_api` payment, do not send a `return_url` in your request. | [optional] |
| delayed_capture | bool | You can use this parameter to delay taking a payment from the paying user’s bank account. For example, you might want to do your own anti-fraud checks on payments, or check that users are eligible for your service. Defaults to `false`. | [optional] |
| description | string | A human-readable description of the payment you’re creating. Paying users see this description on the payment pages. Service staff see the description in the GOV.UK Pay admin tool | |
| string | [optional] | ||
| language | string | Sets the language of the user’s payment page with an ISO-6391 Alpha-2 code of a supported language. | [optional] |
| metadata | \Swagger\Client\Model\ExternalMetadata | [optional] | |
| moto | bool | You can use this parameter to designate a payment as a Mail Order / Telephone Order (MOTO) payment. | [optional] |
| prefilled_cardholder_details | \Swagger\Client\Model\PrefilledCardholderDetails | [optional] | |
| reference | string | Associate a reference with this payment. `reference` is not unique - multiple payments can have identical `reference` values. | |
| return_url | string | The URL the paying user is directed to after their payment journey on GOV.UK Pay ends. | |
| set_up_agreement | string | Use this parameter to set up an existing agreement for recurring payments. The `set_up_agreement` value you send must be a valid `agreement_id`. | [optional] |