Process Scheduled Payments

Methods related to processing recurring schedules

Process Scheduled Payments

POST /ICardProcess/ProcessScheduledPayments

Process the scheduled payments that are due as part of a subscription plan/recurring consent. Return approved and declined transactions. All of the due payments that are associated with the specified merchant are processed.

Request body

---

Response body

---

NumProcessed int

The total number of processed payments.

---

NumApproved int

The number of approved payments.

---

NumDeclined int

The number of declined payments.

---

NumPartialAuths int

The number of payments that got partial authorization.

---

ApprovedPayments List<api_RecurringPayment> (array<object>)

Fields: ConsentID, MerchID, SchedNum, SchedID, TxID, TxApproved, IsPartialApproval, TxnCode, PaymentAmt, PaymentNum, AcctNo, SEQ, CardHolder, CardType, PaymentDate, ConsentType, ErrMsg.

---

DeclinedPayments List<api_RecurringPayment> (array<object>)

Fields: ConsentID, MerchID, SchedNum, SchedID, TxID, TxApproved, IsPartialApproval, TxnCode, PaymentAmt, PaymentNum, AcctNo, SEQ, CardHolder, CardType, PaymentDate, ConsentType, ErrMsg.

Process Scheduled Payments - Selective

POST /ICardProcess/ProcessScheduledPaymentsSelective

Process the scheduled payments that are due as part of a subscription plan/recurring consent. Return approved and declined transactions. Only the payments specified by ScheduleID are processed.

Request body

---

SchedIDs array<int>

IDs of the schedules to process.

Response body

---

NumProcessed int

The total number of processed payments.

---

NumApproved int

The number of approved payments.

---

NumDeclined int

The number of declined payments.

---

NumPartialAuths int

The number of payments that got partial authorization.

---

ApprovedPayments List<api_RecurringPayment> (array<object>)

Fields: ConsentID, MerchID, SchedNum, SchedID, TxID, TxApproved, IsPartialApproval, TxnCode, PaymentAmt, PaymentNum, AcctNo, SEQ, CardHolder, CardType, PaymentDate, ConsentType, ErrMsg.

---

DeclinedPayments List<api_RecurringPayment> (array<object>)

Fields: ConsentID, MerchID, SchedNum, SchedID, TxID, TxApproved, IsPartialApproval, TxnCode, PaymentAmt, PaymentNum, AcctNo, SEQ, CardHolder, CardType, PaymentDate, ConsentType, ErrMsg.