One-time payment and Auto-renew (NCS circ)

Overview

This guide is to explain how NCS Circ/Subscribe one-time and auto-renew payment options are displayed on the front-end applications and how payments are processed. This is a technical documentation

Before you start

Make sure you meet the following pre-requisites before starting the how-to steps:

  • Have Subscribe 3.13.1 version or above

Details

One-time Payment

Display:

  • Previous outstanding balance. Use ‘Balance Due’ field from Circulation API, This value includes tax.

  • Next Payment term and rates: Use ‘Renewal Total Cost’ from Customer Service API. This value includes tax.

Process payment:

  • Authorize and capture the sum of ‘Balance Due’ and ‘Renewal Total Cost’

Auto-renew sign up and previous balance due payment

Display:

  • Previous outstanding balance: UseBalance Due’ field from Circulation API. This value includes tax.

  • Next Payment term and rates: Use ‘Renewal Total Cost’ from Customer Service API. This value includes tax.

Process payment:

  • Auto-renew sign up. This is a billing change request in NCS Circ. No payment is authorized and captured.

  • Previous outstanding balance. Authorize and capture ‘Balance Due’.

‘Grace Owned’ is different than ‘Balance Due’ in NCS Circ Customer Service API. ‘Grace Owned’ is assigned when a subscription is stopped and payment is not settled whereas ‘Balance due’ is for active subscriptions.

Last updated