Use the AvidPay Node to work with curated AvidPay Customer Enrollment and Payments partner APIs from a Flowgear Workflow.
0.0.0.1 - Initial release for the curated AvidPay Customer Enrollment and Payments surface.
0.0.0.2 - Improved generic HTTP-style failure normalization so 4xx and 5xx provider payloads emit standard Flowgear error rows.
0.0.0.3 - Stopped copying list paging metadata onto singular payment-batch detail rows that arrive in an upstream Items transport wrapper.
0.0.0.4 - Added the supported Create a payment batch POST template and its JSON request contract to the curated Payments surface.
0.0.0.5 - Corrected the payment-batch template so Items.Value emits plain raw JSON and uses string batch identifiers instead of nested Flowgear-style wrappers.
0.0.0.6 - Corrected the payment-batch template again so request defaults live on Items.Properties children while the Items container remains a schema-only wrapper.
0.0.0.7 - Corrected the payment-batch contract to use identifier objects for Id and ExternalId, kept nested request arrays schema-driven, and now fail fast when Payments is empty or contains placeholder objects.
0.0.0.8 - Surfaced the documented nested payment-batch request schema for payment rows, payer/payee, check, bank account, remittance, and delivery method fields, and now reject missing required nested fields before the provider call.
0.0.0.9 - Corrected payment-batch create responses to emit one row per provider Results[] item, normalized per-result failures on HTTP 200, and now reject filterless batch-list reads before the provider call.
Use the Connection to store the AvidPay environment, partner credentials, optional default tenant, and the cached bearer token used by the Node methods.
| Property |
Type |
Description |
Environment |
AvidPayEnvironment |
Selects the AvidPay gateway environment used for token and API calls. |
Client ID |
String |
Client identifier issued by AvidPay for the selected environment. |
Client Secret |
Masked |
Client secret issued by AvidPay for the selected environment. |
Subscription Key |
Masked |
Subscription key sent in the avid-ibp-subscription-id header on token and API calls. |
Default Customer Tenant ID |
String |
Optional buyer tenant ID used for tenant-scoped calls when a method template does not supply x-ax-tenant-id in Options. |
Access Token |
Masked |
Cached bearer token used for AvidPay API requests. |
Access Token Expires At UTC |
String |
UTC expiry timestamp recorded for the cached access token. |
- Configure the Connection with the AvidPay credentials issued for the selected environment.
Client ID, Client Secret, and Subscription Key are required.- Many supported operations are tenant-scoped. Set
Default Customer Tenant ID on the Connection unless you plan to supply x-ax-tenant-id in Options for each call.
- Connection test acquires a bearer token from AvidPay and updates the runtime-managed token fields.
- The Node refreshes tokens automatically when the cached token is missing, close to expiry, or rejected by the API.
- The supported surface is curated. Deferred APIs such as proof-of-payment retrieval and webhook-oriented endpoints are intentionally not exposed by templates in this version.
The Node exposes verb-based methods that use curated templates from the embedded AvidPay OpenAPI document.
Reads supported Customer Enrollment and Payments data, including application lookups, customer lookups, payment lists, payment batch reads, payment details, and payment history.
| Parameter |
Type |
Description |
Connection |
Connection |
AvidPay Connection profile. |
OperationId |
String |
Template-selected operation identifier. |
Options |
Object |
Path and query parameters required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Normalized response rows. |
Creates supported Customer Enrollment records and payment batches through the curated POST templates.
| Parameter |
Type |
Description |
Connection |
Connection |
AvidPay Connection profile. |
OperationId |
String |
Template-selected operation identifier. |
Options |
Object |
Path and query parameters required by the selected operation. |
Items |
Array |
JSON request body for the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Normalized response rows. |
Updates supported Customer Enrollment resources such as company, company verification, contract, and bank-account information.
| Parameter |
Type |
Description |
Connection |
Connection |
AvidPay Connection profile. |
OperationId |
String |
Template-selected operation identifier. |
Options |
Object |
Path and query parameters required by the selected operation. |
Items |
Array |
JSON request body for the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Normalized response rows. |
Reserved for future AvidPay delete operations.
| Parameter |
Type |
Description |
Connection |
Connection |
AvidPay Connection profile. |
OperationId |
String |
Template-selected operation identifier. |
Options |
Object |
Path and query parameters required by the selected operation. |
| Return |
Type |
Description |
Response |
Array |
Normalized response rows. In this version, no delete templates are exposed. |
- Use method templates to choose only the supported AvidPay operations exposed by this Node.
- The Node owns paging internally for Customer Enrollment application lists and Payments list endpoints.
- Payment-batch submission uses a JSON request contract with optional identifier-object
Id, required identifier-object ExternalId, and required Payments.
- For request-body templates,
Properties describes the schema and child entries under Items.Properties carry the default values. The top-level Items container and nested request arrays remain schema wrappers.
- Payment-batch templates expose the documented nested payment fields for payer, payee, bank account detail, check, remittances, delivery method, paper-check flags, and expense date.
- Legacy string values supplied for
Id or ExternalId are normalized to identifier objects before the provider call is made.
- Payment-batch create responses emit one Flowgear row per provider
Results[] entry instead of treating the transport as a PaymentBatch object. Each row preserves Reference, Type, Successful, and Errors, and also exposes normalized aliases providerReference, providerType, providerSuccessful, and providerErrors.
- The Node rejects empty
Payments arrays, empty payment objects, and missing required nested payment fields before sending a request, so incomplete Workflows no longer silently produce [] responses.
- Payments list and batch list operations require business filters in
Options. Templates enforce the curated supported patterns before any provider request is sent.
- Payments list rows emit one row per payment item and copy provider paging metadata into
paging.
- Payment-batch detail reads use the provider batch-id path directly and were live-validated with the external batch ID supplied on create.
- Payment-batch detail reads emit the batch row itself and do not copy list paging metadata onto that singular result.
- Customer Enrollment application lists emit one row per application and copy list metadata into
pageInfo.
- Successful and failed rows use the same normalized contract so Workflows can evaluate
status, statusMessage, and errorMessage consistently.
- Customer Enrollment live reads remain tenant-sensitive in the currently validated sandbox profile and were not fully validated with the available local tenant values.
- The
Delete method is present for future expansion, but this version does not expose any delete templates.