Access PaySuite – Additional Information

Access PaySuite Notifications

You can receive notifications in Cyclr when certain actions are performed within Access PaySuite by registering a Cyclr Webhook URL for the following “Entities”:

  • bulkpayment
  • customer
  • contract
  • payment
  • schedule

Registering a Callback URL is required before you’re able to use the Payments > Add Payments Connector Method. See the specific setup for that Method

You can use the Access PaySuite Connector’s Webhooks > Notification Webhook Method to receive notifications by placing one in a Cycle and registering its Webhook URL in Access PaySuite by calling the Access PaySuite Connector’s Callback URLs > Set Callback URL Method, as described below.

Registering a Cyclr Webhook URL

To receive notifications on a Cyclr Webhook URL, you must use the Callback URLs > Set Callback URL Method to register a callback URL for one or more Entities.

To do this:

  1. From within Cyclr, create a Cycle.
  2. Add the Webhooks > Notification Webhook Method to the Cycle.
  3. Select Step setup on the new Step.
  4. Copy its Webhook URL.
  5. Go to the installed Access PaySuite Connector’s Connector Settings page.
  6. Under the Methods and Fields heading, expand the Callback URLs Method Category.
  7. Expand the Set Callback URL Method.
  8. Select the Test tab.
  9. Enter one of the following values for the Entity and the copied Webhook URL for the URL:
    • bulkpayment
    • customer
    • contract
    • payment
    • schedule
  10. Select Run to register the Webhook Step’s URL with Access PaySuite.

The Cycle containing the Notification Webhook Step can now have additional steps added to it and the Cycle started to receive requests.

More than one Entity can be registered to a single Callback URL. To do this, run Set Callback URL for each Entity required with the same URL value.

The Webhooks Method Category on the Access PaySuite Connector is a Custom Object Method Category and can be copied so that Custom Fields can be added to match the structure of data PaySuite sends for different notifications. You will need to do this to map request data from the Notification Webhook Step to other Steps in a Cycle.

Using the “Payments > Add Payments” Connector Method

To be able to use the Payments > Add Payments Method, you must first register a Callback URL with Access PaySuite for the bulkpayment entity. This is all done from within Cyclr, as described below.

Note: Unlike the Payments > Add Payments Method (which adds multiple payments in one call), the Payments > Add Payment Method (which only adds a single payment) does NOT require a Callback URL to be registered.

Registering a Callback URL with Access PaySuite:

  1. From within Cyclr, create a Cycle.
  2. Add the Payments > Bulk Payment Webhook Method to the Cycle.
  3. Select Step setup on the new Step.
  4. Copy its Webhook URL.
  5. Go to the installed Access PaySuite Connector’s Connector Settings page.
  6. Under the Methods and Fields heading, expand the Callback URLs Method Category.
  7. Expand the Set Callback URL Method.
  8. Select the Test tab.
  9. Enter bulkpayment for the Entity and the copied Webhook URL for the URL.
  10. Select Run to register the Webhook Step’s URL with Access PaySuite and then be able to use the Payments > Add Payments Method.

The Payments > Add Payments Method can now be used.

Access PaySuite doesn’t require this Cycle to then be running, but if you wish to perform any actions when bulk payments are made, you can use it and its Bulk Payment Webhook Step to receive notifications relating to them.