---
title: "Get a payment's events"
method: GET
path: "/v1/payments/{paymentId}/events"
tags: ["Card payments"]
---

# Get a payment's events

`GET /v1/payments/{paymentId}/events`

You can use this endpoint to [get a list of a payment’s events](https://docs.payments.service.gov.uk/reporting/#get-a-payment-s-events). A payment event is when a payment’s `state` changes, such as when the payment is created, or when the paying user submits their details.

## Path parameters

- `paymentId` string, required

## Response `200`

OK - your request was successful.

- PaymentEvents — A List of Payment Events information
  - `_links` PaymentLinksForEvents — links for events resource
    - `self` Link — A link related to a payment
      - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
      - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
  - `events` PaymentEvent[]
    - `_links` PaymentEventLink — Resource link for a payment of a payment event
      - `payment_url` Link — A link related to a payment
        - `href` string — A URL that lets you perform additional actions to this payment when combined with the associated `method`.
        - `method` string — An API method that lets you perform additional actions to this paymentwhen combined with the associated `href`.
    - `payment_id` string — The unique ID GOV.UK Pay automatically associated with this payment when you created it.
    - `state` PaymentState — A structure representing the current state of the payment in its lifecycle.
      - `can_retry` boolean, nullable — If `can_retry` is `true`, you can use this agreement to try to take another recurring payment. If `can_retry` is `false`, you cannot take another recurring payment with this agreement. `can_retry` only appears on failed payments that were attempted using an agreement for recurring payments.
      - `code` string — An [API error code](https://docs.payments.service.gov.uk/api_reference/#gov-uk-pay-api-error-codes)that explains why the payment failed. `code` only appears if the payment failed.
      - `finished` boolean — Indicates whether a payment journey is finished.
      - `message` string — A description of what went wrong with this payment. `message` only appears if the payment failed.
      - `status` string — Where the payment is in [the payment status lifecycle](https://docs.payments.service.gov.uk/api_reference/#payment-status-meanings).
    - `updated` string — When this payment’s state changed. This value uses Coordinated Universal Time (UTC) and ISO-8601 format - `YYYY-MM-DDThh:mm:ss.SSSZ`.
  - `payment_id` string — The unique ID GOV.UK Pay automatically associated with this payment when you created it.

## Other responses

- `401` — Your API key is missing or invalid. Read more about [authenticating GOV.UK Pay API requests](https://docs.payments.service.gov.uk/api_reference/#authentication)
- `404` — Not found
- `429` — Too many requests
- `500` — Downstream system error

---

[API](https://skmtc.net/government-digital-service/apis/pay-api.md) · [All operations](https://skmtc.net/government-digital-service/apis/pay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/government-digital-service/pay-api/revisions/9d66a9f54ae4/schema)