Events

recurringPayment.created

Occurs when a recurring payment is created.

Example recurringPayment.created payload:

{
  "data": [
    {
      "id": "360",
      "type": "recurringPayment.created",
      "attributes": {
        "createdAt": "2022-06-25T14:27:41.093Z",
        "amount": 1000,
        "description": "Monthly Subscription",
        "status": "Active"
      },
      "relationships": {
        "recurringPayment": {
          "data": {
            "id": "4",
            "type": "recurringPayment"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        }
      }
    }
  ]
}

---

recurringPayment.failed

Occurs when a payment creation from a recurring payment has failed.

Example recurringPayment.failed payload:

{
  "data": [
    {
      "id": "100",
      "type": "recurringPayment.failed",
      "attributes": {
        "createdAt": "2022-06-11T11:40:58.708Z",
        "failureReason": "The account is frozen"
      },
      "relationships": {
        "recurringPayment": {
          "data": {
            "id": "24",
            "type": "recurringPayment"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        }
      }
    }
  ]
}

---

recurringPayment.statusChanged

Occurs when a recurring payment status has been changed. See Recurring Payment Statuses.

Example recurringPayment.statusChanged payload:

{
  "data": [
    {
      "id": "359",
      "type": "recurringPayment.statusChanged",
      "attributes": {
        "createdAt": "2022-06-25T14:23:26.785Z",
        "previousStatus": "Active",
        "newStatus": "Disabled"
      },
      "relationships": {
        "recurringPayment": {
          "data": {
            "id": "2",
            "type": "recurringPayment"
          }
        },
        "account": {
          "data": {
            "type": "account",
            "id": "10001"
          }
        }
      }
    }
  ]
}

---

Related Payment Events

When a recurring payment triggers and creates an actual payment (ACH or Book), the following events may fire depending on the payment type:

• payment.created - When the payment is created
• payment.sent - When the payment is sent (ACH)
• payment.rejected - If the payment is rejected
• payment.returned - If the ACH payment is returned
• transaction.created - When the transaction is created