Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PP-13711: Fixes incorrect information about the refund webhook #997

Merged
merged 2 commits into from
Feb 26, 2025
Merged

PP-13711: Fixes incorrect information about the refund webhook #997

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a688046
Fixes incorrect information about the refund webhook
NathanD-GDS Feb 25, 2025
0c72477
typo fix
NathanD-GDS Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/webhooks/index.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,9 +172,9 @@ When your webhook receives a message, it’ll look like this:
| ------------------ | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | The unique identifier of this webhook message. |
| `created_date` | date (ISO 8601) | When the payment event happened and activated the webhook.<br><br>This value uses Coordinated Universal Time (UTC) and ISO 8601 format - `YYYY-MM-DDThh:mm:ssZ` |
| `resource_id` | string | The unique ID that GOV.UK Pay automatically generated for the payment or refund.<br><br>When the resource is a payment, `resource_id` is identical to the `payment_id`. When the resource is a refund, `resource_id` is identical to the `refund_id`. |
| `resource` | object | Contains details of the payment or refund that has activated the webhook.<br><br>Attributes in `resource` are the same as you get when finding a payment in the GOV.UK Pay API. <br><br>You can [read about the attributes in the `resource` object on our reference page for getting information about a payment](/api_reference/single_payment_reference). |
| <nobr>`resource_type` | string | Indicates whether the `resource` is a payment or a refund.<br><br>`resource_type` is one of the following:<br><br><li>`payment`<br><li>`refund`|
| `resource_id` | string | The unique ID that GOV.UK Pay automatically generated for the payment.<br><br>`resource_id` is identical to the `payment_id`. |
| `resource` | object | Contains details of the payment that activated the webhook.<br><br>Attributes in `resource` are the same as you get when finding a payment in the GOV.UK Pay API. <br><br>You can [read about the attributes in the `resource` object on our reference page for getting information about a payment](/api_reference/single_payment_reference). |
| <nobr>`resource_type` | string | The type of `resource` this webhook is returning.<br><br>Webhooks on GOV.UK Pay currently only support the `payment` resource.|
| `event_type` | string | The event that activated the webhook. This value will be one of [the events you selected when you created the webhook](/webhooks/#create-a-webhook).<br><br>Possible values are:<br><br><li>`card_payment_succeeded` - your payment service provider has authorised the payment<br><li>`card_payment_captured` - GOV.UK Pay has taken (‘captured’) the payment from the user’s bank account<br><li>`card_payment_settled` - your payment service provider has sent the payment to your bank account.<br><li>`card_payment_refunded` - the refund has been sent to the user’s bank account by your payment service provider |

### Retry mechanism
Expand Down