DELETE Api/RecurringPayment

Deletes an existing recurring payment from the system.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CustomerToken	Contains the unique customer token used to identify the customer the recurring payment is being deleted from.	string	Required
RecurringPaymentID		int	Required

Request Formats

application/json, text/json

Sample:

{
  "CustomerToken": "sample string 1",
  "RecurringPaymentID": 2
}

Response Information

Resource Description

Deletes an existing recurring payment from the system.

APIRecurringPaymentResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorCodeDetail	Detailed error condition code.	string	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when performing the recurring payment request.	Collection of string	None.
Result		RecurringPaymentResponseModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorCodeDetail": "sample string 1",
  "ErrorID": "sample string 2",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "AccountLevelAddonPayments": [
      {
        "AddonCode": "sample string 1",
        "AddonName": "sample string 2",
        "Amount": 3.0
      },
      {
        "AddonCode": "sample string 1",
        "AddonName": "sample string 2",
        "Amount": 3.0
      }
    ],
    "AutoDebit": true,
    "BillerID": 2,
    "BillingAccountID": 1,
    "CreatedByCSR": true,
    "CustomerID": 4,
    "DayToPay": 1,
    "DisplayDescription": "sample string 5",
    "EmailThisManyDaysBeforeBillDue": 1,
    "LastPaymentAccountNumber": "sample string 6",
    "LastPaymentAmount": 1.0,
    "LastPaymentConfirmationNumber": "sample string 7",
    "LastPaymentDate": "2025-05-21T06:35:32.1878155Z",
    "MonthlyAmount": 1.0,
    "NumberOfPayments": 1,
    "OtherData": "sample string 8",
    "RecurringPaymentID": 9,
    "PayAllOutstandingBills": true,
    "PaymentAccountToken": "sample string 11",
    "PaymentAmountType": "AmountDue",
    "PaymentName": "sample string 12",
    "PayOnType": "UponReceipt",
    "PayUntilDescription": "sample string 13",
    "PayUntilType": "I_tell_you_to_stop",
    "PlanType": "RecurringPayment",
    "PPD": true,
    "SetupDate": "2025-05-21T06:35:32.1878155Z",
    "StartDate": "2025-05-21T06:35:32.1878155Z",
    "Status": "Active",
    "RecurringPaymentType": "UponReceipt_AmountDue",
    "ReferenceNumber": "sample string 17",
    "SendRecurringEmailReminder": true,
    "SendEmailNotification": true,
    "StopPaymentOn": "2025-05-21T06:35:32.1878155Z",
    "UpToAmount": 1.0,
    "UserLevelAddonPayments": [
      {
        "AddonCode": "sample string 1",
        "AddonName": "sample string 2",
        "Amount": 3.0
      },
      {
        "AddonCode": "sample string 1",
        "AddonName": "sample string 2",
        "Amount": 3.0
      }
    ]
  },
  "Success": true
}