Skip to content

Commit

Permalink
PP-11862: Adds more digital wallet references (#947)
Browse files Browse the repository at this point in the history
* Adds more digital wallet references

* Small improvement to API reference

* Removes some duplication

* Clarifies some API reference wording based on AB review
  • Loading branch information
NathanD-GDS authored Jan 23, 2024
1 parent a37d9f1 commit 88a588d
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ After you send your request to search payments, you’ll receive a response simi
| `settlement_summary.capture_submit_time` | date (ISO 8601) | The date and time GOV.UK Pay asked your payment service provider to take the payment from your user's account.<br><br>This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.sssZ`.<br><br>`capture_submit_time` only appears if GOV.UK Pay has asked your PSP to take the payment. |
| `settlement_summary.captured_date` | date (ISO 8601) | The date your payment service provider took the payment from your user. <br><br>This value appears in ISO 8601 format - `YYYY-MM-DD`.<br><br>`captured_date` only appears if your payment service provider has taken the payment. |
| `settlement_summary.settled_date` | date (ISO 8601) | The date your payment service provider sent the payment to your bank account as part of a payout. <br><br>This value appears in ISO 8601 format - `YYYY-MM-DD`.<br><br>`settled_date` only appears if your payment service provider is Stripe and they have sent the payment to your bank account. |
| `card_details` | object | Contains details about the card the user paid with.<br><br>`card_details` only appears if the paying user has completed this payment. |
| `card_details` | object | Contains details about the card the user paid with.<br><br>If your user paid with a digital wallet, some information in `card_details` may not match your user's physical card. This is because of [how Apple Pay and Google Pay handle cardholder information](/digital_wallets/#restrictions-of-digital-wallet-payments).<br><br>`card_details` does not appear if the paying user has not completed this payment. |
| `card_details.last_digits_card_number` | number | The last 4 digits of the card the user paid with. |
| `card_details.first_digits_card_number` | number | The first 6 digits of the card the user paid with. |
| `card_details.cardholder_name` | string | The cardholder name the user entered when they paid. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ After you send your request to get information about a payment, you’ll receive
| `settlement_summary.capture_submit_time` | date (ISO 8601) | The date and time GOV.UK Pay asked your payment service provider to take the payment from your user's account.<br><br>This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ss.sssZ`.<br><br>`capture_submit_time` only appears if GOV.UK Pay has asked your payment service provider to take the payment. |
| `settlement_summary.captured_date` | date (ISO 8601) | The date your payment service provider took the payment from your user.<br><br>This value will appear in ISO 8601 format - `YYYY-MM-DD`.<br><br>`captured_date` only appears if your payment service provider has taken the payment. |
| `settlement_summary.settled_date` | date (ISO 8601) | The date your payment service provider sent the payment to your bank account as part of a payout.<br><br>This value will appear in ISO 8601 format - `YYYY-MM-DD`.<br><br>`settled_date` only appears if your payment service provider is Stripe and they have sent the payment to your bank account. |
| `card_details` | object | Contains details about the card the user paid with.<br><br>`card_details` does not appear if the paying user has not completed this payment. |
| `card_details` | object | Contains details about the card the user paid with.<br><br>If your user paid with a digital wallet, some information in `card_details` may not match your user's physical card. This is because of [how Apple Pay and Google Pay handle cardholder information](/digital_wallets/#restrictions-of-digital-wallet-payments).<br><br>`card_details` does not appear if the paying user has not completed this payment. |
| `card_details.last_digits_card_number` | number | The last 4 digits of the card the user paid with. |
| `card_details.first_digits_card_number` | number | The first 6 digits of the card the user paid with. |
| `card_details.cardholder_name` | string | The cardholder name the user entered when they paid. |
Expand Down
16 changes: 6 additions & 10 deletions source/corporate_card_surcharges/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ GOV.UK Pay supports adding a fee or 'surcharge' if your user pays with a corpora
credit or debit card. You can [contact GOV.UK Pay support](/support_contact_and_more_information/) to ask the team to
set this up for you.

Each surcharge is a flat amount added to a payment. If you’d like to discuss
adding surcharges as percentages, please contact us.
Each surcharge is a flat amount added to a payment. If you’d like to discuss adding surcharges as percentages, please contact us.

You can set a different surcharge for each of the following 3 corporate card types:

Expand All @@ -22,10 +21,11 @@ You can set a different surcharge for each of the following 3 corporate card typ

When your user enters a card number in a payment journey, GOV.UK Pay checks to determine if it’s one of the 3 corporate card types. If you have turned on surcharges, we'll tell the user that a surcharge of a certain amount will be added to the total.

We will not apply a surcharge if we cannot tell if the card is:
We will not apply a surcharge if:

- credit or debit
- prepaid or not - we cannot tell this for most Mastercard cards
- we cannot tell if the user is using credit or debit card
- we cannot tell if a card is prepaid or not - we cannot tell this for most Mastercard cards
- the user pays with [a digital wallet](/digital_wallets) like Apple Pay or Google Pay

You can sign in to the [GOV.UK Pay admin
tool](https://selfservice.payments.service.gov.uk/login) to see the payment
Expand All @@ -36,12 +36,8 @@ If a payment has a surcharge applied, the full amount available for refund inclu
If a surcharge is applied to a particular payment, you can see this in API
response fields:

<div style="height:1px;font-size:1px;">&nbsp;</div>

| Response field | Meaning
|----------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| `amount` | Contains the amount in pence, without any surcharge. </br> This field always appears, even if a surcharge is not applicable.|
| `total_amount` | Contains the total amount in pence, including any surcharge. </br> Only appears if a surcharge is applicable. |
| `corporate_card_surcharge` | Contains only the surcharge amount, in pence. </br> Only appears if a surcharge is applicable. |

<div style="height:1px;font-size:1px;">&nbsp;</div>
| <nobr>`corporate_card_surcharge` | Contains only the surcharge amount, in pence. </br> Only appears if a surcharge is applicable. |
10 changes: 7 additions & 3 deletions source/digital_wallets/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,21 @@ Users can only use Google Pay if they're making payments in a supported browser,

Users can only use Apple Pay if they're making payments on a compatible Mac, iPhone, or iPad in a supported browser, such as Safari.

If your payment service provider (PSP) is Stripe, digital wallets are turned on by default. You can still turn off Apple Pay and Google Pay in the GOV.UK Pay admin tool.
If your payment service provider (PSP) is Stripe, both digital wallets are turned on by default.

If your PSP is Worldpay, Apple Pay is turned on by default, but you'll need to turn on Google Pay manually.

You can turn off Apple Pay and Google Pay in the GOV.UK Pay admin tool.

There are no additional PSP fees if your service takes digital wallet payments.

If you have turned off any card brands through the GOV.UK Pay admin tool, these card brands will also be turned off for digital wallet payments.

## Turn on Apple Pay

If your PSP is Stripe, Apple Pay is turned on by default.
Apple Pay is turned on by default for all GOV.UK Pay services.

If your PSP is Worldpay, you'll need to turn on Apple Pay.
If you have turned off or opted out of Apple Pay, you can still enable it through the GOV.UK Pay admin tool.

1. Sign in to the [GOV.UK Pay admin tool](https://selfservice.payments.service.gov.uk/).

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed source/images/flow-payment-details-page.png
Binary file not shown.
6 changes: 4 additions & 2 deletions source/payment_flow/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Redirect your user to `next_url`.

## 4. Your user enters their payment details

When your service redirects your user to `next_url`, they’ll see an **Enter card details** page where they can enter their:
When your service redirects your user to `next_url`, they’ll see an **Enter payment details** page where they can enter their:

* card number
* card expiry date
Expand All @@ -58,9 +58,11 @@ When your service redirects your user to `next_url`, they’ll see an **Enter ca
* billing address
* email address

If your service takes [digital wallet payments](/digital_wallets/), your user can also choose to pay with Apple Pay or Google Pay from this page.

This page also shows the `description` and the amount your user has to pay, making it clear what they’re paying for.

<%= image_tag "/images/flow-payment-details-page.png", { :alt => '' } %>
<%= image_tag "/images/flow-payment-details-page-jan24.png", { :alt => '' } %>

Your user enters their payment details and selects **Continue**. You can also [prefill some of the fields](/optional_features/prefill_user_details).

Expand Down
2 changes: 2 additions & 0 deletions source/reporting/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -331,6 +331,8 @@ You can:

You can [set up which bank accounts your payments go to](/account_structure/) and get information about payments you've received in the admin tool or using the API.

If you take payments through Apple Pay or Google Pay, familiarise yourself with [the cardholder information we store for digital wallet payments](/digital_wallets/#stored-cardholder-information-in-digital-wallet-payments). This information is different from what we store for online payments, and could affect your reconciliation process.

### Reconcile payments with the admin tool

The GOV.UK Pay admin tool can help you reconcile your payments. You can:
Expand Down

0 comments on commit 88a588d

Please sign in to comment.