diff --git a/source/api_reference/create_a_payment_reference/index.html.md.erb b/source/api_reference/create_a_payment_reference/index.html.md.erb index 8d571ae1..767d2447 100644 --- a/source/api_reference/create_a_payment_reference/index.html.md.erb +++ b/source/api_reference/create_a_payment_reference/index.html.md.erb @@ -41,7 +41,7 @@ The data from this endpoint is ‘strongly consistent’, meaning it is updated | `prefilled_cardholder_details.cardholder_name` (optional) | string | Prefills the paying user's cardholder name field when they make their payment.

Limited to 255 characters. | | `prefilled_cardholder_details.billing_address` (optional) | object | An object that prefills the paying user's billing address.

`billing_address` can contain:

  • `line1` (the first line of the paying user’s address)
  • `line2` (the second line of the paying user’s address)
  • `postcode` (the paying user’s postcode)
  • `city` (the paying user’s city)
  • `country` (the paying user’s country, displayed as a 2-character [ISO-3166-1-alpha-2 code](https://www.iso.org/obp/ui/#search/code/))

    Every parameter is optional.

    If the `country` value is invalid or missing, the __Country/territory__ field on the user's payment page defaults to United Kingdom.

    You can [read more about how to prefill cardholder details](/optional_features/prefill_user_details). | | `language` (optional) | string | Sets the language of the user's payment page.

    Available values are:

  • `en` (English)
  • `cy` (Welsh)

    • `language` defaults to `en` if you do not include it in your request body.

    You can [read more about using Welsh on your payment pages](/optional_features/welsh_language). | -| `metadata` (optional) | object | An object that adds custom metadata to a payment using parameter key-value pairs.

    The `metadata` object must contain between 1 and 10 parameter keys.

    Parameter keys are limited to 30 characters. Parameter values are limited to 100 characters. Parameter values can be empty.

    You cannot add or change metadata keys or values after you've created the payment.

    You can [read more about adding custom metadata to payments](/reporting/#add-additional-information-your-users-will-not-be-able-to-see-39-custom-metadata-39-or-39-reporting-columns-39). | +| `metadata` (optional) | object | An object that adds custom metadata to a payment using parameter key-value pairs.

    The `metadata` object must contain between 1 and 15 parameter keys.

    Parameter keys are limited to 30 characters. Parameter values are limited to 100 characters. Parameter values can be empty.

    You cannot add or change metadata keys or values after you've created the payment.

    You can [read more about adding custom metadata to payments](/reporting/#add-additional-information-your-users-will-not-be-able-to-see-39-custom-metadata-39-or-39-reporting-columns-39). | | `moto` (optional) | boolean | You can use this parameter to designate a payment as a Mail Order / Telephone Order (MOTO) payment.

    `moto` defaults to `false` if you do not include it in your request.

    You must have MOTO payments turned on in your GOV.UK Pay account to use the `moto` parameter.

    You can [read more about enabling taking payments over the phone](/moto_payments). | | `authorisation_mode` | string | Sets how you intend to authorise the payment.

    Available values are:

  • `web`
  • `moto_api`
  • `agreement`

    • Defaults to `web`.

    Payments created with `web` mode follow the [standard GOV.UK Pay payment journey](/payment_flow). 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.

    You can [read more about recurring payments](/recurring_payments).

    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.

    You can [read more about authorising payments through the API](/moto_payments/moto_send_card_details_api). | `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`.

    You can [read more about recurring payments](/recurring_payments). |