Skip to main content

PayFabric Installation Instructions

Updated over 2 weeks ago

Before You Begin

Before you install the integration, you need to get some information and settings from your PayFabric account.

The following fields are required for authentication and can be found under PayFabric Settings > Admin > Portal. You will need these:

Required Setting

Location Found

Integration Key
Used as a secure API key for authenticating external applications to communicate with the PayFabric Gateway.

Receivables > Settings > Integration > Connection

Integration Password
Works with the Integration Key as a credential pair to securely authenticate API requests.

Receivables > Settings > Integration > Connection

Device ID
Identifies the specific payment device/profile (gateway account) to be used when processing transactions.

PayFabric > Settings

Device Password
Used together with the Device ID to securely authenticate your application to a specific payment device (gateway account) when processing transactions.

PayFabric > Settings

Portal name
Your company’s PayFabric account (tenant) when making API calls.

Receivables > Settings > Company

Installation Instructions for Integration Setup

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

  2. Click the PayFabric Integration title.

  3. On the Subscription Detail page, click the Subscribe button.

  4. Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.

    • Format: [Product Name] - [Environment/Purpose]

    • Example:PayFabric – MyStore

  5. Select Create Default Mappings (recommended).
    If you don’t want to create default mappings and want to create all mappings from scratch by yourself then uncheck this box.

  6. Enter the value for Invoice Poll Search Days, which defines the number of days the system will look back when retrieving data. This value is calculated at UTC minus the specified value. For example, if the value is 5, the system retrieves records from 5 days ago up to the current UTC time.

  7. Enter the following values you retrieved in Before You Begin:

    • Portal Name

    • Device Password

    • Device ID

    • Integration Password

    • Integration Key

  8. Provide the API URL endpoint for your PayFabric instance.

  9. Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.

    • Recommended Values

      • Initial Setup: 5

      • Ongoing Operations: 500

      • High Volume: 500

  10. Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.

    • Default Value: 60 seconds

    • Range: 60 seconds

  11. Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Akeneo can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

    • Default Value: 5

    • Range: 10

  12. Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

    • Default Value: 5

    • Range: 10

  13. Click Apply to save the settings.

Post-Installation Verification

After completing the installation, perform these tests to verify the installation:

Data Sync Test

  1. Initiate a sample data pull. (To iPaaS.com)

  2. Initiate a sample data push. (From iPaaS.com)

Functionality Test

  1. Run an end-to-end business process.

  2. Validate key features like field mappings, workflow triggers, and logging.

  3. Review integration logs in iPaaS.com.

Support and Troubleshooting

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

  • Documentation: Search our documentation at the top of this article

  • Support Portal: Click the Help and Support button at the lower-right of this window.

  • Contact Information: Contact iPaaS.com

Did this answer your question?