Skip to content

Commit

Permalink
PP-12126: Minor docs updates (January/February 2024) (#948)
Browse files Browse the repository at this point in the history
* Updates provider_id description

* Fixes typo and further clarification

* Minor changes to docs

* Fixes page names
  • Loading branch information
NathanD-GDS authored Jan 31, 2024
1 parent dc569fd commit 7c63c99
Show file tree
Hide file tree
Showing 10 changed files with 11 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The data from this endpoint is ‘strongly consistent’, meaning it is updated
| `description` (required) | 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.<br><br>Limited to 255 characters and should not contain URLs. |
| `set_up_agreement` (optional) | string | Use this parameter to set up an existing agreement for recurring payments. <br><br>The `set_up_agreement` value you send must be a valid `agreement_id`.<br><br>[Read more about taking recurring payments](/recurring_payments). |
| `delayed_capture` (optional) | boolean | 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. <br><br>You can [read more about delaying taking a payment from the paying user's bank account](/delayed_capture/#delay-taking-a-payment).<br><br>Defaults to `false`. |
| `email` (optional) | string | Prefills the paying user's email address field when they make their payment. <br><br>Limited to 254 characters.<br><br>You can [read more about prefilling fields](/optional_features/prefill_user_details) on the **Enter card details** page. |
| `email` (optional) | string | Prefills the paying user's email address field when they make their payment. <br><br>Limited to 254 characters.<br><br>You can [read more about prefilling fields](/optional_features/prefill_user_details) on the **Enter payment details** page. |
| `prefilled_cardholder_details` (optional) | object | An object that prefills the paying user's address and cardholder name fields when they make their payment.<br><br>`prefilled_cardholder_details` can contain 2 optional parameters: <br><br><li>`cardholder_name`</li><li>`billing_address`</li><br>You can [read more about using this object to prefill payment fields](/optional_features/prefill_user_details). |
| `prefilled_cardholder_details.cardholder_name` (optional) | string | Prefills the paying user's cardholder name field when they make their payment.<br><br>Limited to 255 characters. |
| `prefilled_cardholder_details.billing_address` (optional) | object | An object that prefills the paying user's billing address.<br><br>`billing_address` can contain:<br><br><li>`line1` (the first line of the paying user’s address)<li>`line2` (the second line of the paying user’s address)<li>`postcode` (the paying user’s postcode)<li>`city` (the paying user’s city)<li>`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/))<br><br>Every parameter is optional.<br><br>If the `country` value is invalid or missing, the __Country/territory__ field on the user's payment page defaults to United Kingdom.<br><br>You can [read more about how to prefill cardholder details](/optional_features/prefill_user_details). |
Expand Down
2 changes: 1 addition & 1 deletion source/api_reference/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We use the same base URL for test and live accounts. You can create a test accou

The API key you use determines which GOV.UK Pay service you use, and whether actions are treated as test payments, or processed as real payments. You can create test and live API keys through the GOV.UK Pay admin tool.

<%= warning_text('If you’re testing our API, make sure you enter an API key from a test account to avoid generating real payments.') %>
<%= warning_text('If you’re testing our API, make sure you enter an API key from a test account to avoid creating real payments.') %>

The API is based on REST principles. It returns data in JSON format, and uses standard HTTP status codes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ After you send your request to search payments, you’ll receive a response simi
| `total_amount` | number | Amount your user paid in pence, including corporate card fees.<br><br>`total_amount` only appears if you added a corporate card surcharge to the payment. <br><br>You can [read more about corporate card surcharges.](/corporate_card_surcharges/#add-corporate-card-fees). |
| `fee` | number | The payment service provider's transaction fee, in pence.<br><br>`fee` only appears when we have taken ('captured') the payment from the user or if their payment fails after they submitted their card details.<br><br>You can [read more about PSP fees](/reporting/#psp-fees). |
| `net_amount` | number | The amount, in pence, that'll be paid into your bank account after your payment service provider takes the `fee`. |
| `provider_id` | string | The unique ID your payment service provider generated for this payment.<br><br>This is not the same as the `payment_id`. |
| `provider_id` | string | The unique ID your payment service provider generated for this payment.<br><br>`provider_id` only appears after the user has submitted their payment details and GOV.UK Pay has tried to authorise the payment with your PSP.<br><br>This is not the same as the `payment_id`. |
| `return_url` | string | The URL you directed the paying user to after their payment journey on GOV.UK Pay ended.<br><br>You can [read more about choosing your return URL and matching the paying user to a payment](/making_payments/#choose-the-return-url-and-match-your-users-to-payments). |
| <nobr>`authorisation_mode`</nobr> | string | How GOV.UK Pay will authorise this payment.<br><br>Possible values are:<br><br><li>`web`<li>`moto_api`<li>`agreement`<br><br>`authorisation_mode` is set when you create a payment. You can [read more about the different authorisation modes in our API reference page for creating payments](/api_reference/create_a_payment_reference). |
| `results._links` | object | Contains URLs and methods for actions related to this payment. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ After you send your request to get information about a payment, you’ll receive
| `total_amount` | number | Amount your user paid in pence, including corporate card fees.<br><br>`total_amount` only appears if you added a corporate card surcharge to the payment.<br><br>You can [read more about corporate card surcharges](/corporate_card_surcharges/#add-corporate-card-fees). |
| `fee` | number | The payment service provider's (PSP) transaction fee, in pence.<br><br>`fee` only appears when we have taken ('captured') the payment from the user or if their payment fails after they submitted their card details.<br><br>`fee` will not appear if your PSP is Worldpay or you are using an API key from a test service.<br><br>You can [read more about PSP fees](/reporting/#psp-fees). |
| `net_amount` | number | The amount, in pence, that will be paid into your bank account after your payment service provider takes the `fee`.<br><br>`net_amount` can be a negative number if Stripe charges fees on a failed payment.<br><br>You can [read more about PSP fees](/reporting/#psp-fees). |
| `provider_id` | string | The unique ID your payment service provider generated for this payment.<br><br>This is not the same as the `payment_id`. |
| `provider_id` | string | The unique ID your payment service provider generated for this payment.<br><br>`provider_id` only appears after the user has submitted their payment details and GOV.UK Pay has tried to authorise the payment with your PSP.<br><br>This is not the same as the `payment_id`. |
| `return_url` | string | The URL you directed the paying user to after their payment journey on GOV.UK Pay ended.<br><br>You can [read more about choosing your return URL and matching the paying user to a payment](/making_payments/#choose-the-return-url-and-match-your-users-to-payments). |
| <nobr>`authorisation_mode` | string | How GOV.UK Pay will authorise this payment.<br><br>Possible values are:<br><br><li>`web`<li>`moto_api`<li>`agreement`<br><br>`authorisation_mode` is set when you create a payment. You can [read more about the different authorisation modes in our API reference page for creating payments](/api_reference/create_a_payment_reference). |
| `authorisation_summary` | object | Contains information about 3D Secure (3DS) authentication.<br><br>`authorisation_summary` only appears if the payment was authenticated with 3DS and the payment was created on or after 1 September 2021. |
Expand Down
5 changes: 2 additions & 3 deletions source/integrate_with_govuk_pay/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ You will likely need some kind of server-side datastore to record payment inform

## The GOV.UK Pay API

The GOV.UK Pay API offers a set of operations to conduct and report on
payments. For more information:
The GOV.UK Pay API offers a set of endpoints to help your organisation reconcile and report on payments. For more information:

- read our [API reference](/api_reference)
- look at our <a href="https://github.com/alphagov/pay-publicapi/blob/master/openapi/publicapi_spec.json" target="blank">OpenAPI file</a>
Expand Down Expand Up @@ -127,7 +126,7 @@ tool](https://selfservice.payments.service.gov.uk/), then selecting **Settings**

This change can take up to 15 minutes to take effect.

If you collect your users' billing addresses in your service before you redirect them to GOV.UK Pay, you can [prefill the billing address field](/optional_features/prefill_user_details) on the __Enter card details__ page.
If you collect your users' billing addresses in your service before you redirect them to GOV.UK Pay, you can [prefill the billing address field](/optional_features/prefill_user_details) on the __Enter payment details__ page.

<%= warning_text('If you turn off billing address collection, your service will receive a `null` `billing_address` object in API responses. <br><br> The `billing_address` object is inside the `card_details` object. <br><br> You should check if disabling billing address collection will affect your service‘s integration with GOV.UK Pay.') %>

Expand Down
2 changes: 1 addition & 1 deletion source/moto_payments/moto_api/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Make sure you've [turned on MOTO (telephone or post) payments on your account](/

1. Go to the [`next_url`](/making_payments/#receiving-the-api-response) included in the body of the response to your API request.

1. Fill in your user’s payment details on the **Enter card details** page. The **Enter Card Details** page will not have a billing address field, even if you've turned on billing address collection on your service.
1. Fill in your user’s payment details on the **Enter payment details** page. The **Enter payment details** page will not have a billing address field, even if you've turned on billing address collection on your service.

1. Confirm the payment on the **Confirm your payment** page. You will not need to do 3D Secure confirmation.

Expand Down
2 changes: 1 addition & 1 deletion source/optional_features/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ You can customise your payments pages with GOV.UK Pay in the following ways:
* [add custom branding](/optional_features/custom_branding/#add-custom-branding) to payment pages
* [use Welsh](/optional_features/welsh_language/#use-welsh-on-your-payment-pages) on payment pages
* [use your own payment failure pages](/optional_features/use_your_own_error_pages)
* [prefill fields](/optional_features/prefill_user_details/) on the **Enter card details** page
* [prefill fields](/optional_features/prefill_user_details/) on the **Enter payment details** page
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 5240

# Prefill payment fields

If you collect your users' details in your service before you redirect them to GOV.UK Pay, you can prefill some of the fields on the __Enter card details__ page. If you prefill fields, your users should not need to enter their details twice.
If you collect your users' details in your service before you redirect them to GOV.UK Pay, you can prefill some of the fields on the __Enter payment details__ page. If you prefill fields, your users should not need to enter their details twice.

Your users can still edit these details before they complete their payment.

Expand Down
2 changes: 1 addition & 1 deletion source/quick_start_guide/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ lets you:
* issue full or partial refunds
* create agreements to take recurring payments

You'll be able to generate API keys for 2 different accounts. These are your:
You'll be able to create API keys for 2 different accounts. These are your:

- test ('sandbox') account, for [testing the GOV.UK Pay API and your service](/testing_govuk_pay)
- live account, for taking payments from your users after you [switch to live](/switching_to_live)
Expand Down
2 changes: 1 addition & 1 deletion source/switching_to_live/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ You make a real payment using either:

1. Select __Settings__, then __API keys__.

1. Generate a new live API key.
1. Create a new live API key.

1. [Make a real payment](/making_payments/#take-a-payment) using the new live API key.

Expand Down

0 comments on commit 7c63c99

Please sign in to comment.