PayConnect

Use the PayConnect Node to work with PayConnect invoices from a Flowgear Workflow.

Revision History

0.0.0.1 - Initial PayConnect Node article for the invoice-first V2 connector surface.
0.0.0.2 - Expanded the direct invoice surface to include get-by-id and pay-invoice operations.
0.0.0.3 - Updated get-by-id behavior to return invoices through the working invoice search path when the direct provider route returns unauthorized.

Connection

The PayConnect Connection stores the values the Node uses to authenticate invoice requests.

Property	Type	Description
UseProductionEnvironment	Boolean	Uses the production PayConnect API endpoints instead of the sandbox endpoints.
ApiKey	Masked	The PayConnect API key used to create a session token. The Node formats the required Api-Key authorization header for you.
SessionToken	Masked	The cached PayConnect session token used for invoice requests. This value is managed by the Node at runtime.
SessionExpiresAtUtc	String	The UTC expiry value returned for the current session token. This value is managed by the Node at runtime.
TimeoutSeconds	Integer	The HTTP timeout, in seconds, used for session creation and validation calls.

Setup Notes

Create a PayConnect Connection before using the Node in a Workflow.

The Node supports both sandbox and production environments:

• Sandbox: https://dev.payconnect.us/api
• Production: https://my.payconnect.us/api

The Node creates and refreshes short-lived PayConnect session tokens automatically from the API key stored in the Connection.

Connection testing uses invoice search to confirm that the API key can create a session token and that the session token can access the supported invoice surface.

Methods

The PayConnect Node exposes four methods. The available templates under these methods cover the supported direct PayConnect invoice operations:

• Create invoice
• Search invoices
• Get invoice by ID
• Update invoice
• Pay invoice
• Send invoice email
• Void invoice

Create

Use Create to create invoices.

Parameter	Type	Description
Connection	Connection	The PayConnect Connection to use for the request.
OperationId	String	Identifies the create template to execute.
Options	Object	Additional route values required by the selected create template.
Items	Array	The structured request body for the selected create template.

Return	Type	Description
Response	Array	Returns normalized output rows together with PayConnect response fields such as invoiceId and correlationId when available.

Retrieve

Use Retrieve to search invoices or get one invoice by ID.

Parameter	Type	Description
Connection	Connection	The PayConnect Connection to use for the request.
OperationId	String	Identifies the retrieve template to execute.
Options	Object	The structured options for the selected retrieve template. Search templates accept structured search filters and the Node handles paging internally. Get-by-ID requires invoiceId.

Return	Type	Description
Response	Array	Search returns one normalized row per invoice and includes a pagination object on each row. Get-by-ID returns one normalized row for the requested invoice.

Update

Use Update to update invoices.

Parameter	Type	Description
Connection	Connection	The PayConnect Connection to use for the request.
OperationId	String	Identifies the update template to execute.
Options	Object	Additional route values required by the selected update template.
Items	Array	The structured request body for the selected update template.

Return	Type	Description
Response	Array	Returns normalized output rows together with the provider response fields returned for the invoice update.

Action

Use Action to run invoice actions such as pay-invoice, send-email, and void.

Parameter	Type	Description
Connection	Connection	The PayConnect Connection to use for the request.
OperationId	String	Identifies the action template to execute.
Options	Object	Additional route values required by the selected action template.
Items	Array	The structured request body for the selected action template when the action requires one.

Return	Type	Description
Response	Array	Returns normalized output rows together with the provider response fields for the selected action.

Usage Notes

Use the method templates to select the supported PayConnect operation instead of entering raw endpoint details manually.

All method outputs are normalized to include:

• status
• statusMessage
• errorMessage

For successful requests, status is OK. For failed requests, status is ERROR.

For invoice search, the Node emits one row per invoice instead of a single wrapper row. The PayConnect pagination metadata is attached to each emitted invoice row.

Get-by-ID uses invoice search internally and returns the matching invoice row for the requested invoiceId. This avoids the direct PayConnect get-by-id route when it returns unauthorized for otherwise valid session tokens.

When a PayConnect response includes a provider status field that would conflict with Flowgear's normalized status, the provider value is returned as providerStatus.

Known Issues

• The Node still targets the direct invoice API surface only. Hosted-payment helpers, company-scoped management APIs, subscriptions, customers, and transaction-management endpoints remain outside the current V2 Node surface.
• PayConnect does not publicly document the complete search filter vocabulary, so available search filtering is limited to the documented template surface.