Skip to main content

PayFabric Installation Instructions

Install the PayFabric integration to iPaaS.com

PayFabric Installation Instructions

Before you install the integration, gather the following from your PayFabric account. In the PayFabric portal, set the Integration Method to API only so these credentials can authenticate.

PayFabric uses two credential families: the Receivables Sync credentials (Portal Name, Integration Key, Integration Password) authenticate customer, invoice, and payment sync; the Device credentials (Device ID, Device Password) authenticate refunds and voids and are only required if you will process them.

Setting

Where to find it in PayFabric

Required

Portal Name — your company's PayFabric account (tenant) identifier.

Receivables > Settings > Company

Yes

Integration Key — the API key authenticating to the Receivables service.

Receivables > Settings > Integration > Connection

Yes

Integration Password — paired with the Integration Key.

Receivables > Settings > Integration > Connection

Yes

Device ID — identifies the payment device (gateway account) for refunds and voids.

PayFabric > Settings (Device Management)

Conditional — only for refunds/voids

Device Password — paired with the Device ID.

PayFabric > Settings (Device Management)

Conditional — only for refunds/voids

Note: The Device Password is shown only once when the device is created. If it is lost, create a new device to generate a new Device ID and password.

For a full reference on each setting, see Connections and Settings.

Installation Instructions for Integration Setup

  1. Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.

    Search Certified Integration Marketplace
  2. Click the PayFabric integration tile.

    PayFabric marketplace tile
  3. On the Subscription Detail page, click Subscribe.

  4. Enter a subscription name and select a version (the latest version has the most features). Use the format [Product Name] - [Environment/Purpose], for example PayFabric - Production.

  5. Select Create Default Mappings (recommended). Leave it unchecked only if you intend to build every mapping from scratch yourself.

    PayFabric Subscription Settings
  6. Provide the API URL for your PayFabric instance:

    • Test/Sandbox: https://sandbox.payfabric.com

    • Production: provided by PayFabric for your account

  7. Enter the Portal Name, Integration Key, and Integration Password from Before You Begin. If you will process refunds or voids, also enter the Device ID and Device Password.

  8. Enter Invoice Poll Search Days — the number of days before the current UTC time the integration looks back when polling PayFabric for changed invoice payments. It applies on the first poll or whenever there is no recorded last-poll date. Defaults to 5 when left blank.

  9. Enter the API Throttle Limit — the number of API requests that may run simultaneously, protecting PayFabric from being overwhelmed.

    • Initial Setup: 5

    • Ongoing Operations: 500

    • High Volume: 500

  10. Enter the API Throttle Seconds — the time window over which the API Throttle Limit is measured. Requests beyond the limit are rejected until the window resets.

    • Default: 60 seconds

  11. Enter the number of Concurrent Connections — the maximum number of simultaneous API connections the integration may open. Requests beyond this are queued or rejected until an active connection finishes.

    • Default: 5

  12. Enter the number of Concurrent Batch Executions — the maximum number of transfers the integration runs simultaneously within a batch.

    • Default: 5

  13. Click Apply to save the settings.

Post-Installation Verification

After completing the installation, verify it with the following tests:

Data Sync Test

  1. Initiate a sample data pull (to iPaaS.com) — for example, poll an invoice payment from PayFabric.

  2. Initiate a sample data push (from iPaaS.com) — for example, manually sync a customer to PayFabric.

Functionality Test

  1. Run an end-to-end business process (e.g., create a customer, then an invoice, then a payment).

  2. Validate field mappings, trigger events, and logging.

  3. Review the integration logs under Dashboard / Integration Monitoring / Error Logs.

Support and Troubleshooting

Click the Help button on any iPaaS.com page to contact Support or search the documentation.

Related Documents

Did this answer your question?