Paystand v2

Provides integration with Paystand, a business-payments platform used to manage receivables, payments, and related financial operations through APIs.

Connect Paystand API operations to a Flowgear Workflow through template-driven query, create, update, delete, and action methods.

Revision History

0.0.0.1 - Initial release.
0.0.0.2 - Maintenance release.
0.0.0.3 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.0.0.5 - Maintenance release.

Connection

Use this Connection to store the Paystand credentials and runtime settings shared by all methods.

Property Type Description
Base Url String Base URL for Paystand API calls. The default is https://api.paystand.co/v3. Leave the default unless Paystand gives you a different host.
Client Id String Client identifier used to request bearer tokens for authenticated endpoints.
Client Secret Masked Client secret used to request bearer tokens for authenticated endpoints.
Customer Id String Customer identifier sent in the X-CUSTOMER-ID header for authenticated endpoints.
Publishable Key Masked Publishable key sent in the X-PUBLISHABLE-KEY header for Paystand operations that use publishable-key authentication. The operations available in the template picker use bearer authentication, so you can leave this blank.
Scope String OAuth scope requested during token acquisition. Leave the default auth unless Paystand instructs you otherwise.
Timeout (seconds) Integer Request timeout used for connection validation and runtime API calls. The default is 30 and the value must be greater than zero.

Setup Notes

  • Request Paystand Developer API access from Paystand and collect the clientId, clientSecret, and customerId values for your application.
  • Create the Flowgear Connection and leave Base Url as https://api.paystand.co/v3 unless Paystand gives you an environment-specific host.
  • Enter Client Id, Client Secret, and Customer Id. These values are required for the authenticated operations exposed by the Node, such as customers, receivables, credit memos, payments, refunds, disputes, fees, transfers, and withdrawals.
  • Leave Scope as auth unless Paystand instructs you to request a different scope.
  • Run the Connection test before you build a Workflow. The test acquires a client-credentials bearer token and makes a low-risk customer-list call to confirm that the credentials can reach the Paystand API.

Methods

The Node exposes metadata-driven methods so you can select a supported Paystand OperationId from templates instead of building raw HTTP requests. Each method lists only the operations that belong to it, and the Node rejects an OperationId that belongs to a different method.

Query

Use Query for supported GET operations such as credit memos, customers, receivables and receivable transactions, payments, refunds, disputes, fees, fee setting plans, transfers, withdrawals, and the merchant time zone.

Parameter Type Description
Connection Connection Paystand Connection details.
OperationId String Template-selected identifier for the Paystand read operation to execute.
Options Object Path and query values required by the selected operation.
Return Type Description
Response Array One response row per returned item or singleton result, preserving provider fields under Response and the normalized Flowgear status under Response.Flowgear.

Create

Use Create for supported resource-creating POST operations such as credit memos, customers, and receivables.

Parameter Type Description
Connection Connection Paystand Connection details.
OperationId String Template-selected identifier for the Paystand create operation to execute.
Options Object Path and query values required by the selected operation.
Items Array JSON request body rows for the selected operation. Provide at least one JSON object.
Return Type Description
Response Array One response row per submitted item, including the provider payload and Response.Flowgear success or failure details.

Update

Use Update for supported PUT operations that update credit memos, customers, and receivables.

Parameter Type Description
Connection Connection Paystand Connection details.
OperationId String Template-selected identifier for the Paystand update operation to execute.
Options Object Path and query values required by the selected operation.
Items Array JSON request body rows for the selected operation. Provide at least one JSON object.
Return Type Description
Response Array One response row per submitted item, including the provider payload and Response.Flowgear success or failure details.

Delete

Use Delete for supported delete operations where the selected Paystand endpoint removes the targeted resource, such as deleting a receivable attachment.

Parameter Type Description
Connection Connection Paystand Connection details.
OperationId String Template-selected identifier for the Paystand delete operation to execute.
Options Object Path and query values required by the selected operation.
Return Type Description
Response Array One response row per delete request, including the provider payload and Response.Flowgear success or failure details.

Action

Use Action for supported non-create POST and PATCH operations such as activating or canceling a credit memo, canceling a receivable, computing fees, computing fee-split fees, and splitting fees.

Parameter Type Description
Connection Connection Paystand Connection details.
OperationId String Template-selected identifier for the Paystand action operation to execute.
Options Object Path and query values required by the selected operation.
Items Array Optional JSON request body rows for the selected action. Provide at least one JSON object when the selected operation has a request body. Operations without a request body run once and ignore Items.
Return Type Description
Response Array One response row per submitted action item, or one row for an action without a request body, including the provider payload and Response.Flowgear success or failure details.

Usage Notes

  • Use the template picker to choose the OperationId that matches the Paystand endpoint you want to call. Templates provide the expected Options and Items structure for that operation.
  • The Node chooses the required auth mode from operation metadata. Authenticated operations use a client-credentials bearer token plus X-CUSTOMER-ID, while publishable-key operations use X-PUBLISHABLE-KEY.
  • Every row contains Response.Flowgear.IsSuccess and Response.Flowgear.Message. When a Create, Update, or Action row was produced from a submitted item, Response.Flowgear.Request echoes that item.
  • Query methods flatten Paystand results envelopes into one row per item and copy the envelope count and settings values into Response.PaystandCollection. Empty list responses return zero rows instead of a synthetic success row.
  • The Node handles supported Paystand limit and offset paging, including the f.limit and f.offset variants, internally. It requests pages of 200 items and removes these paging values from the Options template, so you do not need to manage transport paging in the Workflow for standard list operations.
  • When a Query fails, including during paging, the Node raises an execution failure instead of returning a normal row.
  • When a Create, Update, Delete, or Action request fails at Paystand, the Node returns a failure row with Response.Flowgear.IsSuccess set to false and preserves the provider error details under Response.PaystandError. Processing continues with the next item.
  • The Node caches the bearer token and acquires a new one when it is missing or within five minutes of expiry. When Paystand returns a raw 401 Unauthorized, the Node acquires a fresh bearer token and retries the request once before surfacing the failure.
  • When a Query request returns 429 Too Many Requests or 503 Service Unavailable, the Node waits briefly and retries it up to two times.

Known Issues

  • Paystand's published docs reviewed for this connector do not clearly identify a separate sandbox host. If Paystand gives you a sandbox-specific host, update Base Url manually before testing.
  • Paystand attachment upload and attachment update operations are not available in the template picker because they require multipart file requests rather than JSON Items.