PayFabric API Endpoints

This article catalogs the PayFabric API endpoints the integration calls, grouped by entity, for firewall whitelisting, troubleshooting, and impact assessment when PayFabric changes its API.

The integration calls PayFabric over REST. The base URL is instance-specific and set in the API URL subscription setting:

Sandbox / Test: https://sandbox.payfabric.com
Production: provided by PayFabric for your account

In the endpoint patterns below, [Base URL] is that instance URL and {PortalName} is your PayFabric Portal Name.

Areas covered: Customer & Company · Invoice · Invoice Payment · Refund (Payment/Gateway) · Authentication

Customer and Company Endpoints

PayFabric has no separate company entity — both customers and companies are stored as PayFabric customers and use the same endpoints (companies are written with a COMP-prefixed CustomerId).

Get a Customer or Company (GET)

Retrieves a customer (or company) by its PayFabric id.

[Base URL]/receivables/sync/api/{PortalName}/api/customers?id={id}

Create or Update a Customer or Company (POST)

Creates the customer, or updates it when the id already exists (PayFabric upserts on the CustomerId). The same endpoint serves both Add and Update.

[Base URL]/receivables/sync/api/{PortalName}/api/customers

Find a Customer by Field (GET)

Used to locate an existing PayFabric customer by a field value (for example, by email) so the integration can link to it instead of creating a duplicate.

[Base URL]/receivables/sync/api/{PortalName}/api/reports/customers?filter.criteria.{searchField}.EqualsTo={searchFieldValue}

Invoice Endpoints

Get an Invoice (GET)

Retrieves an invoice by its PayFabric invoice id.

[Base URL]/receivables/sync/api/{PortalName}/api/invoices?identity={invoiceId}

Create or Update an Invoice (POST)

Creates or updates the invoice (used for both new invoices and refund balance updates).

[Base URL]/receivables/sync/api/{PortalName}/api/invoices

Invoice Payment Endpoints

Get a Payment by Id (GET)

Retrieves a single payment by its id.

[Base URL]/receivables/sync/api/{PortalName}/api/payments/byId?id={id}

Retrieve Payments Modified Since a Time (GET)

Used by the integration's polling to find invoice payments changed since the last poll. Results are paged with filter.PageSize and filter.PageIndex.

[Base URL]/receivables/sync/api/{PortalName}/api/payments?filter.criteria.ModifiedOn.Min={utcTimeString}&filter.PageSize={pageSize}&filter.PageIndex={pageIndex}

Create or Update a Payment (POST)

Posts a payment record. The integration uses this to write the refund Payment record (PaymentType Refund) to the Receivables Payments screen.

[Base URL]/receivables/sync/api/{PortalName}/api/payments

Refund Endpoints (Payment / Gateway Service)

Refunds and voids use PayFabric's Payment / Gateway service, which authenticates with the Device credentials (see Authentication).

Get a Transaction by Key (GET)

Retrieves a gateway transaction by its key — used to read the total refund amount for an invoice.

[Base URL]/payment/api/transaction/{key}

Process a Refund or Void (POST)

Processes the refund (or void) through the gateway.

[Base URL]/payment/api/transaction/process

Authentication Endpoint

Get an Access Token (POST)

The integration obtains a Receivables Sync session token using your Portal Name, Integration Key, and Integration Password. The request is form-encoded with grant_type=password, username set to the Integration Key, and password set to the Integration Password.

[Base URL]/receivables/sync/api/{PortalName}/api/token

Authentication

The integration uses two credential sets, matching the two services above:

Receivables Sync service (customers, companies, invoices, payments) — authenticated with the session token obtained from the token endpoint above using the Portal Name, Integration Key, and Integration Password.
Payment / Gateway service (refunds and voids) — authenticated with the Device ID and Device Password.

See Connections and Settings for where to find each credential and Installation Instructions for first-time setup.