The integration calls the PayTrace REST API v3, which exchanges JSON (the sign-in request is form-encoded). Every call carries the PayTrace Integrator ID that iPaaS.com manages, and a bearer token from the Authorization Endpoint below.

The base URL is the subscription's API Url setting:

For example, a production subscription reads an invoice at https://api.paytrace.com/v3/invoice/{invoice_id}?merchant_id={merchant_id}.

In the endpoints below, {merchant_id} is the merchant the API user belongs to, which the integration reads from PayTrace; you never enter it.

Reads which merchant the subscription's API user belongs to. The merchant id is used on every invoice call.

Creates the PayTrace invoice for the amount still owed, with its invoice number, email recipients and payment-notification address. PayTrace emails it to the customer when SendEmail is true.

Reads an invoice's status, amount and recipients, to decide whether to reuse, replace or delete it and to reconcile payments.

Reads the invoice's pay link, which is written onto the iPaaS.com transaction.

Lists the merchant's invoices created between a start date and an end date (and, optionally, with a given status). Used to find an invoice by its number and by the reconciliation poll, which searches in windows of at most 14 days.

Deletes an invoice when the transaction is cancelled or deleted, or before a changed invoice is replaced. Its pay link stops working. A paid invoice is never deleted.

Lists the card transactions in a date range, including the invoice each payment was made on. Used to bring payments, refunds, voids, declines and authorizations back as payment lines.

The integration signs in with the API user's username and password (the OAuth client credentials grant) and receives a short-lived bearer token, renewed automatically before it expires. The URL follows the subscription's API Url, so production and sandbox each sign in to their own environment.