Overview

This node interacts with the Bayarcash API to list all available portals. It is useful for users who want to retrieve a comprehensive list of portals configured in their Bayarcash account, which can be used for further processing or integration in workflows. For example, a user might want to display all portals in a dashboard or use the portal information to create payment intents.

Use Case Examples

1. Retrieve all portals to display in a user interface.
2. Fetch portals to use their IDs in subsequent API calls for payment processing.

Output

JSON

• portal_name - Name of the portal
• portal_key - Unique identifier key of the portal
• otherProperties - Other properties returned by the Bayarcash API for each portal

Dependencies

• Bayarcash API with an API authentication token (PAT token)

Troubleshooting

• Authentication failed: Ensure the API token is valid and not expired.
• Validation errors: Check that the request parameters are correctly formatted.
• Forbidden errors: Verify that the account has permission to access portal data.
• Not found errors: Confirm the API endpoint is correct and the resource exists.
• Server errors: Retry after some time or contact Bayarcash support if persistent.

Links

• Bayarcash API Documentation - Portals - Official documentation for the portals endpoint in Bayarcash API