logoOPG Event Store

payment-received
v0.0.1

The payment has been successful in GOV.UK Pay

Trigger

MRLPA has directed a user to GOV.UK Pay and GOV.UK Pay has sent them back with confirmation that the transaction is complete.

This does not mean the payment has arrived in OPG's bank account.

Effect

Sirius fetches the payment details from GOV.UK Pay and stores a payment record in its database so the payment can be displayed in the UI.

Consumer / Producer Diagram

Open in Visualiser →

Examples

1{
2  "uid": "M-1234-5678-9012",
3  "paymentId": "hu20sqlact5260q2nanm0q8u93",
4  "amount": 8200
5}
6
payment-received Schema (json)
{
  "$id": "https://opg.service.justice.gov.uk/opg.poas.makeregister/payment-received.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "opg.poas.makeregister/payment-received",
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "description": "The UID of the LPA",
      "pattern": "^M(-[A-Z0-9]{4}){3}$"
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment in GovUK Pay"
    },
    "amount": {
      "type": "integer",
      "description": "The amount paid in pence"
    }
  },
  "required": ["uid", "paymentId", "amount"]
}
Edit this pageLast updated on 2024/11/22