PaySpace

Provides integration with PaySpace by using the embedded OpenAPI definition for query, mutation, and delete operations.

Revision History

0.0.0.9 - Initial release.
0.0.0.14 - Improved error message handling.

Connection

The Connection stores the PaySpace API endpoint details, credentials, and token settings used for template generation and execution.

Property	Type	Description
API Base URL	String	The base URL for PaySpace API calls. The default is https://api.payspace.com.
Auth Base URL	String	The base URL for PaySpace authentication. The default is https://identity.payspace.com.
Client ID	String	The client ID issued by PaySpace.
Client Secret	Masked	The client secret issued by PaySpace.
Grant Type	PaySpaceGrantType	The scope requested when authenticating.
Company ID	String	The company identifier used to populate PaySpace paths.
Timeout (seconds)	Integer	The timeout applied to token and API calls.
Ignore Duplicate Path Errors	Boolean	When true, duplicate path signature errors are ignored while parsing the OpenAPI document.
Access Token	Masked	The access token returned by PaySpace authentication.

Setup Notes

1. Request the PaySpace API credentials from your PaySpace account manager.
2. Confirm the required API scope with PaySpace, and then select the appropriate Grant Type.
3. Configure the Connection, and then test it so Flowgear can request an Access Token.
4. Set Company ID when your templates or operations need a default company context.

Methods

The PaySpace Node exposes separate methods for query, mutation, and delete operations.

Query

Executes read-only operations defined in the embedded OpenAPI specification.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation.

Mutation

Creates or updates PaySpace resources.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.
Items	Array	Optional request body items sent to the selected operation.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation.

Delete

Deletes PaySpace resources by using the selected OpenAPI template.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation.

Usage Notes

• Use the template picker to select the correct OperationId for Query, Mutation, or Delete.
• Query operations page through results automatically. User-supplied $top, $skip, and $count values are ignored so the Node can manage paging consistently.
• PaySpace value envelopes are unwrapped when possible so downstream Steps receive predictable objects.