Recurring Payment Created (recurringPaymentCreated)

Sent when a recurring payment (VRP) consent has been created.

Id: recurringPaymentCreated

Event that notifies when a recurring payment consent has been created. Use recurringPaymentRequestId with the recurring payments API to read the consent.

This event reports that the consent was created. It is not sent again for each later payment made against that consent.

Payload

These fields are sent in the payload object of the webhook envelope.

Name	Type	Description
recurringPaymentRequestId	string	The id of the recurring payment request
authorizationRequestId	string	The id of the authorisation request
status	string	The recurring payment consent status. `Authorised` means payments can be made against the consent
submittedAt	string	The time the recurring payment consent was submitted (UTC, ISO 8601)

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "recurringPaymentCreated",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "recurringPaymentRequestId": "03d1bb92-dff1-49ed-8721-62090936bb3a",
    "authorizationRequestId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "status": "Authorised",
    "submittedAt": "2024-03-20T10:00:00Z"
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.

Recurring Payments (VRP)

Updated about 6 hours ago

Payload

Example (JSON format)

Related