-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PP-13561: Minor documentation changes (#988)
* Minor documentation changes * Update source/switching_to_live/index.html.md.erb * Update source/switching_to_live/index.html.md.erb
- Loading branch information
1 parent
1563b1f
commit 63f84d3
Showing
6 changed files
with
25 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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:[email protected]) 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:[email protected]) 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). | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -93,10 +93,14 @@ Email [[email protected]](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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters