diff --git a/source/webhooks/index.html.md.erb b/source/webhooks/index.html.md.erb index f6d8e91e..30f1cf0d 100644 --- a/source/webhooks/index.html.md.erb +++ b/source/webhooks/index.html.md.erb @@ -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.

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.

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.

Attributes in `resource` are the same as you get when finding a payment in the GOV.UK Pay API.

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). | -| `resource_type` | string | Indicates whether the `resource` is a payment or a refund.

`resource_type` is one of the following:

  • `payment`
  • `refund`| +| `resource_id` | string | The unique ID that GOV.UK Pay automatically generated for the payment.

    `resource_id` is identical to the `payment_id`. | +| `resource` | object | Contains details of the payment that activated the webhook.

    Attributes in `resource` are the same as you get when finding a payment in the GOV.UK Pay API.

    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). | +|
    `resource_type` | string | The type of `resource` this webhook is returning.

    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).

    Possible values are:

  • `card_payment_succeeded` - your payment service provider has authorised the payment
  • `card_payment_captured` - GOV.UK Pay has taken (‘captured’) the payment from the user’s bank account
  • `card_payment_settled` - your payment service provider has sent the payment to your bank account.
  • `card_payment_refunded` - the refund has been sent to the user’s bank account by your payment service provider | ### Retry mechanism