ALalphagov
Card payments

Return payment events by ID

Changed on

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'

get/v1/payments/{paymentId}/events

Request

  • Base URL
    https://publicapi.payments.service.gov.uk
  • URL
    https://publicapi.payments.service.gov.uk/v1/payments/{paymentId}/events
  • Auth
    API key in header Authorization

Path parameters

paymentIdstring required

Payment identifier

Response

OK

payment_idstring

Example response

{
  "events": [
    {
      "payment_id": "hu20sqlact5260q2nanm0q8u93",
      "state": {
        "status": "created",
        "message": "User cancelled the payment",
        "code": "P010"
      },
      "updated": "2017-01-10T16:44:48.646Z",
      "_links": {
        "payment_url": {
          "href": "https://an.example.link/from/payment/platform",
          "method": "GET"
        }
      }
    }
  ],
  "payment_id": "hu20sqlact5260q2nanm0q8u93",
  "_links": {
    "self": {
      "href": "https://an.example.link/from/payment/platform",
      "method": "GET"
    }
  }
}

Changes

  • 6d52e43c48aaRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

  • 884c555517bcRevision changes
    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security Authorization was removed from the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status