Running merchant-initiated transactions for a payment plan

Payment plans can have transactions that are initiated by the merchant or on the merchant backend server. For general information about payment plans, see Getting started with pay plans.

This option is for cases where you want to manually run the transactions for a card, echeck, or payment through PayPal (with Braintree). and have Nexio manage sending transaction requests automatically according to a schedule.

With this option, the merchant must manually track a balance for a customer as payments are run. This allows the merchant to control when transactions run or to make a change such as lowering the payment amount for a time. The downside to this approach is that the merchant must remember to run the transactions at the appropriate time and date. It is possible to create an application or website using the Nexio API to run these transactions, but each transaction must be sent individually.

The steps for implementing this type of payment plan depend on the payment method:

  • cards - Configure the Run card transaction endpoint to run with a saved card token or the full card information. You need to indicate a paymentType in the initial transaction and an appropriate one in the subsequent transactions. For tutorials on manually-run card transactions, see the Running a card transaction with the API or Running a card transaction using full card information topic.
  • echecks - You can manually run the initial echeck transaction using a saved echeck token and then reuse that token, when allowed by the gateway, to run subsequent transactions. For a tutorial on running these transactions, see the Running an echeck transaction with the API topic.
  • APMs - PayPal (with Braintree) allows you to run an initial transaction by including the saveRecurringToken parameter, saving the apm.token from the response, and then using that token for subsequent transactions. For a tutorial on running these transactions, see the integration guide.

See also