POST Api/RecurringPayment

Revise an existing recurring payment in the system.

Request Information

URI Parameters

None.

Body Parameters

APIRecurringPaymentAddUpdateRequestModel

Name	Description	Type	Additional information
AccountLevelAddonPayments		Collection of APIRecurringPaymentAddonModel	None.
Amount	A dollar amount to be paid on the bill.	decimal?	None.
CustomerToken	Contains the unique customer token used to identify the customer the recurring payment is being added/edited for.	string	Required
DateToStart	Date to start the recurring payment.	date-time	Required
DateToStop	Date to Stop the Recurring Payment	date-time?	None.
DayToPay	Indicates what day of the month to pay the bill.	int?	None.
FeeWaived	Specifies whether this recurring payment has fee waived.	boolean	None.
IsPPD	Check if the recurring payment request confirmation option is PPD. Prearranged Payment and Deposit Entries (PPD): The merchant obtains written authorization to credit or debit to a consumer's bank account	boolean	None.
NumberToStopOn	The number of payments to make before stopping recurring payments.	int?	None.
OtherData	Other Data	string	Required String length: inclusive between 0 and 100
PayAllOutstandingBills	Option to pay unpaid invoices as part of the first recurring payment.	boolean	Required
PaymentAccount	For enrolled or one-time payments, contains the new payment account information to use for the payment. Will be saved as an available payment account for enrolled customers.	PaymentAccountModel	None.
PaymentAccountToken	For enrolled payments, contains the payment account token of the existing payment account to use.	string	String length: inclusive between 0 and 2048
PaymentName	The name to be given the recurring payment.	string	Required
PayThisAmount	An enum selecting how to choose the amount to be paid on a bill.	PayThisAmount	Required
PayThisBill	An enum selecting when in the payment cycle to pay the bill.	PayThisBill	Required
RecurringPaymentID	The id of an existing RecurringPayment record. The value must be greater than zero for update and delete. It is not required for add.	int?	None.
RecurringPaymentStopType	An enum selecting the Stop Type for the recurring payment.	RecurringPaymentStopType	Required
ReferenceNumber	Reference Number	string	Required String length: inclusive between 0 and 100
ReminderDaysBeforeDue	Indicates how many days before a payment date to send a notification regarding the recurring payment.	int?	Range: inclusive between 1 and 180
UserLevelAddonPayments		Collection of APIRecurringPaymentAddonModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerToken": "sample string 1",
  "AccountLevelAddonPayments": [
    {
      "AddonCode": "sample string 1",
      "AddonName": "sample string 2",
      "Amount": 3.0
    },
    {
      "AddonCode": "sample string 1",
      "AddonName": "sample string 2",
      "Amount": 3.0
    }
  ],
  "UserLevelAddonPayments": [
    {
      "AddonCode": "sample string 1",
      "AddonName": "sample string 2",
      "Amount": 3.0
    },
    {
      "AddonCode": "sample string 1",
      "AddonName": "sample string 2",
      "Amount": 3.0
    }
  ],
  "RecurringPaymentID": 1,
  "ReferenceNumber": "sample string 2",
  "OtherData": "sample string 3",
  "PaymentAccount": {
    "AchAccountNumber": "sample string 1",
    "AchInstitutionNumber": "sample string 2",
    "AchRememberMe": true,
    "AchRoutingNumber": "sample string 3",
    "AchRegion": "USA",
    "AchTransitNumber": "sample string 4",
    "AchType": "Unknown",
    "AchUsageType": "Unknown",
    "AchValidate": true,
    "Address": "sample string 6",
    "Address2": "sample string 7",
    "Agree": true,
    "CcAccountNumber": "sample string 15",
    "CcCardType": "Unknown",
    "CcCVV": "sample string 16",
    "CcExpirationDate": "sample string 17",
    "CcRememberMe": true,
    "City": "sample string 19",
    "Country": "sample string 20",
    "Description": "sample string 21",
    "EnrollInRTP": true,
    "IsPinacleAccount": true,
    "IsRTP": true,
    "IsWalkIn": true,
    "Name": "sample string 25",
    "NotifyBillsToPinacle": true,
    "SingleUse": true,
    "SkipAccountOwnerCheck": true,
    "SkipCardPreauth": true,
    "State": "sample string 30",
    "Token": "sample string 31",
    "Zip": "sample string 32",
    "TerminalID": "sample string 36",
    "AccountType": "ACH"
  },
  "PaymentAccountToken": "sample string 4",
  "PaymentName": "sample string 5",
  "PayAllOutstandingBills": true,
  "IsPPD": true,
  "DateToStart": "2025-05-21T06:35:34.5158724Z",
  "RecurringPaymentStopType": "I_tell_you_to_stop",
  "PayThisBill": "UponReceipt",
  "PayThisAmount": "AmountDue",
  "DateToStop": "2025-05-21T06:35:34.5158724Z",
  "NumberToStopOn": 1,
  "Amount": 1.0,
  "DayToPay": 1,
  "FeeWaived": true,
  "ReminderDaysBeforeDue": 1
}

Response Information

Resource Description

Revise an existing recurring payment in 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:34.5471034Z",
    "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:34.5627285Z",
    "StartDate": "2025-05-21T06:35:34.5627285Z",
    "Status": "Active",
    "RecurringPaymentType": "UponReceipt_AmountDue",
    "ReferenceNumber": "sample string 17",
    "SendRecurringEmailReminder": true,
    "SendEmailNotification": true,
    "StopPaymentOn": "2025-05-21T06:35:34.5627285Z",
    "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
}