---
title: "Return payment events by ID"
method: GET
path: "/v1/payments/{paymentId}/events"
tags: ["Card payments"]
---

# Return payment events by ID

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

Return payment events information about a certain payment The Authorisation token needs to be specified in the 'authorization' header as 'authorization: Bearer YOUR_API_KEY_HERE'

## Path parameters

- `paymentId` string, required

## Response `200`

OK

- PaymentEvents — A List of Payment Events information
  - `events` PaymentEvent[]
    - `payment_id` string
    - `state` PaymentState — A structure representing the current state of the payment in its lifecycle.
      - `status` string — Current progress of the payment in its lifecycle
      - `finished` boolean — Whether the payment has finished
      - `message` string — What went wrong with the Payment if it finished with an error - English message
      - `code` string — What went wrong with the Payment if it finished with an error - error code
    - `updated` string — updated
    - `_links` PaymentEventLink — Resource link for a payment of a payment event
      - `payment_url` Link — A link related to a payment
        - `href` string
        - `method` string
  - `payment_id` string
  - `_links` PaymentLinksForEvents — links for events resource
    - `self` Link — A link related to a payment
      - `href` string
      - `method` string

## Other responses

- `401` — Credentials are required to access this resource
- `404` — Not found
- `429` — Too many requests
- `500` — Downstream system error

---

[API](https://skmtc.net/alphagov/apis/gov-uk-pay-api.md) · [All operations](https://skmtc.net/alphagov/apis/gov-uk-pay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alphagov/gov-uk-pay-api/versions/262275a01170/schema)