Skip to content

Commit

Permalink
PP-13561: Minor documentation changes (#988)
Browse files Browse the repository at this point in the history
* Minor documentation changes

* Update source/switching_to_live/index.html.md.erb

* Update source/switching_to_live/index.html.md.erb
  • Loading branch information
NathanD-GDS authored Jan 28, 2025
1 parent 1563b1f commit 63f84d3
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The data from this endpoint is ‘strongly consistent’, meaning it is updated
| Name | Type | Description |
|-----|-----|-----|
| `amount` (required) | number | Sets the amount the user will pay, in pence.<br><br>Minimum value depends on your PSP. If your PSP is: <li>Stripe, the minimum value is `30` (30 pence) <li>Worldpay, [contact Government Banking](mailto:serviceteam.gbs@hmrc.gov.uk) to find out your minimum `amount` value<br><br>Maximum value is `10000000` (£100,000) if your PSP is Stripe. [Contact us](/support_contact_and_more_information/) to take payments above this amount.<br><br>Maximum value is `500000` (£5,000) if your PSP is Worldpay. [Contact Government Banking](mailto:serviceteam.gbs@hmrc.gov.uk) to take payments above this amount. |
| `reference` (required) | string | Associate a reference with this payment. <br><br>`reference` is not unique - multiple payments can have identical `reference` values.<br><br>Limited to 255 characters and must not contain URLs. |
| `reference` (required) | string | Associate a reference with this payment.<br><br>`reference` is a way of linking this payment to other parts of your payment system. For example, you could set it to an existing invoice number or customer reference number.<br><br>`reference` is not unique - multiple payments can have identical `reference` values.<br><br>Limited to 255 characters and must not contain URLs. |
| `return_url` (required) | string | The URL the paying user is directed to after their payment journey on GOV.UK Pay ends.<br><br>Limited to 2,000 characters and must not be JSON-encoded.<br><br>You can [read more about choosing your return URL and matching paying users to payments](/making_payments/#choose-the-return-url-and-match-your-users-to-payments). |
| `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). |
Expand Down
11 changes: 11 additions & 0 deletions source/moto_payments/moto_send_card_details_api/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,17 @@ To send a user's card details through the API, you need to set the payment’s a

[Create a payment ](/making_payments/) using the `POST /v1/payments` endpoint and include `"authorisation_mode": "moto_api"` in the request body. You do not need to include a `return_url` in your request because there's no user to return.

This example request creates a £150 payment that will be authorised by sending the user card details through the API:

```json
{
"amount": 15000,
"reference" : "12345",
"description": "Pay your council tax",
"authorisation_mode": "moto_api"
}
```

You’ll receive a response that includes the `auth_url_post` object within the `_links` object. `auth_url_post` contains the URL (`href`), method (`method`), and unique token (`one_time_token`) you need to authorise the payment through our API. `auth_url_post` looks like this:

```json
Expand Down
8 changes: 6 additions & 2 deletions source/recurring_payments/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,14 @@ Email [govuk-pay-support@digital.cabinet-office.gov.uk](mailto:govuk-pay-support

### 3. Turn on recurring payments with your payment service provider

If your PSP is Worldpay, you must turn on tokenisation on your account before you can take recurring payments. Contact your Worldpay relationship manager and ask them to turn on tokenisation.

If your PSP is Stripe, you do not need to do anything before you start setting up recurring payments.

If your PSP is Worldpay, you must:

* create a new GOV.UK Pay service to take recurring payments
* contact your Worldpay relationship manager and ask them to turn on tokenisation on your Worldpay account
* make sure you have the 2 required merchant codes - one merchant code for one-off payments, and one merchant code for recurring payments

When you've tested your recurring payments service, follow our [go live documentation](/switching_to_live) to start taking payments from your users.

## Create an agreement for recurring payments
Expand Down
2 changes: 2 additions & 0 deletions source/switching_to_live/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ During the go live process, you'll need to:

Select your test ('sandbox') account or your test Stripe account in the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/my-services), then select __Request a live account__.

If you have a Worldpay test account, you still need to request a live account from your sandbox.

We'll respond within one working day, and we can usually activate your live account on the same day.

Your live account will appear on the __Overview__ page in the GOV.UK Pay admin tool, labelled __Live account__.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ weight: 7110

# Connect your live account to Stripe

This is part of [going live](/switching_to_live/#go-live).
This is part of [going live](/switching_to_live/#go-live). You need to complete the steps on that page before continuing here.

Stripe is GOV.UK Pay's contracted PSP.

After you request a live GOV.UK Pay account and confirm you will connect it to Stripe, we'll review your request to go live. After we approve your request, you need to add more details about your service and organisation.
After you request a live GOV.UK Pay account and confirm you will connect it to Stripe, we'll review your request to go live. After we approve your request, you need to add more details about your service and organisation in the GOV.UK Pay admin tool.

We'll send these details to Stripe and manage the relationship with Stripe on your behalf.

You must add:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 7120

# Connect your live account to Worldpay

This is part of [going live](/switching_to_live/#go-live).
This is part of [going live](/switching_to_live/#go-live). You need to complete the steps on that page before continuing here.

Government Banking's contracted payment service provider (PSP) is currently Worldpay. You must be a central government or health sector organisation to use Government Banking's contracted PSP.

Expand Down

0 comments on commit 63f84d3

Please sign in to comment.