Integrate iPaaS.com with PayTrace to send invoices for card payment through PayTrace's invoicing (Trace AR Checkout) and bring the payments, amount paid and balance back onto the iPaaS.com invoice.
How to Connect
Prerequisites
A PayTrace merchant account with invoicing enabled for API access. Ask PayTrace to enable Trace AR Checkout for API access on the merchant. Until it is enabled, every invoice is refused with PAYTRACE-AUTH-1004.
A PayTrace API user for iPaaS.com, with all permissions. Create it in PayTrace under Users → New User, with Type of User set to API User and Select All under Permissions (check that the permissions are ticked), for this integration only. A missing permission shows as PAYTRACE-AUTH-1006. PayTrace disables a user after four consecutive failed sign-ins (see PayTrace API Response Codes), so a user shared with other systems could be locked out for all of them by one wrong password.
The right environment. An API user belongs either to PayTrace production or to the PayTrace sandbox. Use production credentials with the production API Url, and sandbox credentials with the sandbox API Url.
Configuration Details
API Url: PayTrace's API address. Production: https://api.paytrace.com. Sandbox: https://api.sandbox.paytrace.com.
API Username: the username of the PayTrace API user created for iPaaS.com. Example: ipaas-invoicing.
API Password: that API user's password.
No merchant id is needed: the integration asks PayTrace which merchant the API user belongs to.
Configure Subscription Settings
Field | Description | Required | Example |
API Url | PayTrace's API address. A blank value means production; an address without "https://" or with a trailing "/v3" is accepted. | Yes | |
API Username | The PayTrace API user's username. | Yes | ipaas-invoicing |
API Password | The PayTrace API user's password. It is never shown or logged. | Yes | (your password) |
Reconciliation Days | How far back the reconciliation poll looks: it checks transactions changed in the last this-many days. It also bounds how far back a PayTrace invoice is looked up by its number. Blank, 0 or not a number means 60; the most is 365. | No | 60 |
After Partial Payment | What happens when the customer paid less than the total on the pay page. | No | Re-issue Payment |
After Partial Refund | What happens when part of a payment is refunded in PayTrace. | No | Handle Manually |
After Full Refund | What happens when a whole payment is refunded in PayTrace. | No | Handle Manually |
After Voided Payment | What happens when a payment is voided in PayTrace. | No | Handle Manually |
After Cancelled Invoice | What happens when the PayTrace invoice is cancelled or deleted in PayTrace while the transaction still awaits payment. | No | Handle Manually |
After Expired Invoice | What happens when the PayTrace invoice expires unpaid. | No | Handle Manually |
Balance Settings
PayTrace closes an invoice after any payment on it, and an invoice that expired or was cancelled in PayTrace cannot be paid either. When money is still owed in one of the six situations above, its setting decides what happens:
Re-issue Payment: a new PayTrace invoice for the balance is created under the same invoice number and sent to the same recipients; PayTrace emails it when the earlier invoice was emailed. Its pay link is written onto the transaction. Any read of the invoice can do this: a payment notification, a reconciliation poll or a Manual Sync.
Handle Manually: nothing is sent at that moment. PayTrace Amount Paid and PayTrace Balance on the transaction show where the invoice stands, and your invoicing system updates the transaction.
The defaults are Re-issue Payment for After Partial Payment and Handle Manually for the other five. A blank or unrecognised value uses the default. Subscriptions keep the value they saved, so check these six settings on existing subscriptions.
Authentication Methods
Enter the API Url, API Username and API Password on the subscription settings page and save.
The integration signs in to PayTrace with the API username and password and receives a short-lived access token, which it renews automatically before it expires. The token is kept in memory only.
Every call to PayTrace also carries the integration's PayTrace Integrator ID, which iPaaS.com manages; you do not enter it. If it is missing or refused, transfers fail with PAYTRACE-AUTH-1003: contact iPaaS.com Support.
If PayTrace refuses the username and password (PAYTRACE-AUTH-1002), the same values are not sent again for 30 minutes, so retries do not use up the four attempts. Corrected values are tried at once.
Changing credentials: create or reset the API user's password in PayTrace, enter the new values on the subscription and save. The next transfer signs in with them.
Settings problems are named before any call: an empty required setting gives PAYTRACE-AUTH-1001, and an API Url that is not a web address gives PAYTRACE-AUTH-1007. A transfer may show only "Unable to connect to subscription"; the code is in the company's logs.
Initialization Support
Currently, initialization is not supported for PayTrace in iPaaS.com. All data synchronization and mappings must be configured manually during the integration process. Invoices already awaiting payment when you subscribe are sent when they next change in iPaaS.com, or with a Manual Sync of the Transaction ID.
Throttling
The subscription's throttle fields are pre-populated with these defaults: API Throttle Limit 500 and API Throttle Seconds 60, the same for API Throttle Limit (To iPaaS) and API Throttle Seconds (To iPaaS), Concurrent Connections 10 and Concurrent Batch Executions 10. The Installation Instructions give recommended values for initial setup and high volume. When PayTrace's own rate limit is reached, the transfer is rescheduled automatically and resumes when the limit resets (PAYTRACE-RATE-1001); no action is required. See Subscription Configuration – Edit in the iPaaS.com Help Center for what each throttle field does.