Skip to content

Commit

Permalink
PP-13711: Fixes incorrect information about the refund webhook (#997)
Browse files Browse the repository at this point in the history 
* Fixes incorrect information about the refund webhook

* typo fix
  • Loading branch information
@NathanD-GDS
NathanD-GDS authored Feb 26, 2025
1 parent 69705f0 commit c2be93a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/webhooks/index.html.md.erb
View file
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

0 comments on commit c2be93a

Please sign in to comment.