Skip to main content

PayFabric to iPaaS.com Invoice Mapping Documentation

PayFabric to iPaaS.com Invoice Mapping Documentation

When an invoice payment is created or updated in PayFabric, the integration updates the associated Transaction in iPaaS.com so the iPaaS.com record stays current, and records the payment as a Transaction Payment. This direction is poll-based — the integration periodically retrieves changed PayFabric invoice payments. Only transactions that already exist in iPaaS.com are updated.

ID Format

Manual Sync ID Format

On the iPaaS.com Manual Sync page, enter the PayFabric record identifier for the invoice/payment to pull.

External ID Format

The transaction is matched in iPaaS.com by the external-id link established when it was originally created; this collection updates the existing transaction and does not create a new one.

Deleted Record Support

Not supported. Deletions in PayFabric are not propagated to iPaaS.com by this collection.

Custom Field Support

The payment child writes several values into iPaaS.com transaction-payment custom fields: PaymentId (into the paymentId custom field — required for the payment to be created without error), Currency, and Transaction Key. These let subsequent updates match the payment to its originating PayFabric transaction.

Mapping Collection Status

Status: Enabled (the payment child is gated by the filter below)

Trigger Events: Poll. The integration polls PayFabric for changed invoice payments on its schedule; the look-back window is controlled by the Invoice Poll Search Days preset (UTC minus the configured days), applied on the first poll or whenever the last poll date is empty. This collection is poll-based and does not use webhook subscriptions. Manual Sync is also available.

Duplicate or Conflicting Mappings

No other collection updates iPaaS.com transactions from PayFabric; this parent and its payment child are the only TO iPaaS.com collections.

Supported Child Collections

  • Update PayFabric Invoice Payment TO iPaaS.com — writes the PayFabric payment to iPaaS.com as a Transaction Payment under the updated transaction.

System Caveats

PayFabric Caveats

  • PayFabric enforces payment uniqueness.

iPaaS.com Caveats

  • The transaction must already exist in iPaaS.com; this collection updates it and does not create new transactions.

  • The PayFabric payment method must already exist in iPaaS.com. If it does not, the payment transfer raises an error prompting you to create the method manually.

Setup Requirements

iPaaS.com Configuration

Integration Flow

  1. The integration polls PayFabric for invoice payments changed since the last poll (or within the Invoice Poll Search Days window on first run).

  2. The related invoice/transaction is retrieved and matched to the existing iPaaS.com Transaction.

  3. The transaction header is updated, preserving the transaction's existing field values.

  4. The payment is written to iPaaS.com as a Transaction Payment through the child collection, after the payment method is validated.

Mappings

Update PayFabric Invoice TO iPaaS.com

Description. Updates the existing iPaaS.com transaction during a payment-driven sync, preserving the transaction's own values (DestinationValue passthrough) while the Status is translated from PayFabric. This collection has no mapping filter.

Mapping Type

Source Field (PayFabric)

Destination Field (iPaaS.com)

Description

Lookup

Lookup Translation: PayFabric Invoice Status TO iPaaS.com

Status

Translates the PayFabric invoice status into the iPaaS.com transaction status.

Dynamic Formula

DestinationValue.TransactionNumber;

TransactionNumber

Preserves the existing iPaaS.com transaction number.

Dynamic Formula

DestinationValue.SystemId;

SystemId

Preserves the existing iPaaS.com SystemId.

Dynamic Formula

DestinationValue.CustomerId;

CustomerId

Preserves the existing iPaaS.com CustomerId.

Dynamic Formula

DestinationValue.CompanyId;

CompanyId

Preserves the existing iPaaS.com CompanyId.

Dynamic Formula

DestinationValue.Type;

Type

Preserves the existing iPaaS.com transaction Type.

Dynamic Formula

DestinationValue.EmailAddress;

EmailAddress

Preserves the existing iPaaS.com email address.

Dynamic Formula

DestinationValue.DiscountAmount;

DiscountAmount

Preserves the existing discount amount.

Dynamic Formula

DestinationValue.TaxAmount;

TaxAmount

Preserves the existing tax amount.

Dynamic Formula

DestinationValue.ShippingAmount;

ShippingAmount

Preserves the existing shipping amount.

Dynamic Formula

DestinationValue.Subtotal;

Subtotal

Preserves the existing subtotal.

Dynamic Formula

DestinationValue.Total;

Total

Preserves the existing total.

Dynamic Formula

DestinationValue.TotalQty;

TotalQty

Preserves the existing total quantity.

Lookup Translation — PayFabric Invoice Status TO iPaaS.com. The PayFabric invoice status is translated to the iPaaS.com transaction status through this translation collection. The value pairs are configured per environment; review them in iPaaS.com to confirm they match your transaction status set.

Update PayFabric Invoice Payment TO iPaaS.com

Mapping Filter

var isValidPaymentMethod =await IsValidPaymentMethod(PaymentMethod);
if(isValidPaymentMethod == false){ 
    throw new exception("This payment method "+PaymentMethod+" does not exist and needs to be created manually in iPaaS.");
}return true;

Filter Description. Before the payment is written, the integration checks that the PayFabric payment method exists in iPaaS.com. If it does not, the transfer raises the error "This payment method [method] does not exist and needs to be created manually in iPaaS." (where [method] is the PayFabric payment method name) and the payment is not created. Create the payment method in iPaaS.com and retry. When the method is valid, the payment is processed.

Description. Writes the PayFabric payment to iPaaS.com as a Transaction Payment.

Mapping Type

Source Field (PayFabric)

Destination Field (iPaaS.com)

Description

Field

PaymentId

PaymentId

Required. Stored in the iPaaS.com paymentId custom field so the payment is created without error and can be matched on later updates.

Field

PaymentMethod

Method

The payment method; must already exist in iPaaS.com (see the filter).

Field

Amount

Amount

The payment amount from PayFabric.

Field

Status_Transaction

Status

The payment status, from the PayFabric transaction status.

Field

TrxAuthCode_Transaction

Description

The payment description, from the PayFabric transaction authorization code.

Field

Currency

Currency

The payment currency, stored in the iPaaS.com Currency custom field.

Dynamic Formula

Transaction Key (see formula below)

Transaction Key

The PayFabric transaction key, stored in the iPaaS.com Transaction Key custom field; matches the payment to its originating transaction.

Transaction Key formula:

if(!string.IsNullOrWhiteSpace(TransactionKey_Transaction))
    return TransactionKey_Transaction;
return null;

Error Handling

  • "This payment method [method] does not exist and needs to be created manually in iPaaS." — Raised when a polled PayFabric payment uses a method that has not been created in iPaaS.com. Create the matching payment method in iPaaS.com, then re-sync the payment.

Testing & Validation

Test Scenarios

  1. Record a payment against an invoice in PayFabric and confirm, after the next poll, that the payment appears on the associated iPaaS.com transaction.

  2. Confirm the transaction's own header values are preserved (not overwritten) by the payment-driven update.

  3. Record a payment using a method that does not exist in iPaaS.com and confirm the documented error is raised.

  4. Manually sync a PayFabric payment and confirm the payment and its Transaction Key custom field are recorded in iPaaS.com.

  5. Confirm the polling look-back honors the Invoice Poll Search Days preset on the first poll.

Validation Checklist

  • The transaction already exists in iPaaS.com before its payment is polled.

  • The payment method exists in iPaaS.com.

  • The Status translation has been reviewed for the target environment.

Additional Notes

  • The header field mappings deliberately preserve the existing iPaaS.com transaction values; this collection's purpose is to attach the PayFabric payment and refresh the status, not to overwrite transaction data.

Related Documents

Did this answer your question?