Bayarcash icon

Bayarcash

Consume Bayarcash API

Actions6

Overview

This node integrates with the Bayarcash API to retrieve payment-related data. Specifically, the Get Portal Channels operation under the Portal resource fetches all available payment channels for a specified portal. This is useful when you want to dynamically obtain which payment methods or channels are enabled and accessible through a particular Bayarcash portal.

Common scenarios:

  • Displaying or selecting payment channels dynamically in a workflow based on the portal configuration.
  • Validating or auditing the payment channels available for a given portal before processing payments.
  • Integrating with other systems that require knowledge of active payment channels per portal.

Example:
You have multiple portals configured in Bayarcash for different regions or business units. Before creating payment intents, you want to list all payment channels available for a specific portal to ensure compatibility or to present options to end users.

Properties

Name Meaning
Portal ID The unique identifier of the portal to get channels for. This is required to specify which portal's payment channels should be retrieved.

Output

The output is a JSON array containing the details of the payment channels associated with the specified portal. Each item in the array corresponds to a payment channel object as returned by the Bayarcash API.

  • The json output field contains the raw response from the API representing the portal's payment channels.
  • No binary data is output by this operation.

Dependencies

  • Requires an API key credential (a personal access token) for authenticating requests to the Bayarcash API.
  • The node expects the Bayarcash API base URL and authentication token to be configured in the credentials.
  • Network connectivity to the Bayarcash API endpoint is necessary.

Troubleshooting

Common issues:

  • Authentication failures: If the API token is invalid or expired, the node will return an authentication error.
  • Invalid Portal ID: Providing a non-existent or incorrect portal ID will result in a "Not found" error.
  • Permission errors: If the API token does not have permission to access the portal or its channels, a forbidden error occurs.
  • Server errors: Temporary issues on the Bayarcash server may cause 5xx errors.

Error messages and resolutions:

  • Authentication failed:
    "Authentication failed: Invalid or expired PAT token. Please check your credentials."
    → Verify and update the API token in the node credentials.

  • Validation error:
    "Validation error: The API could not process your request."
    → Check that the Portal ID is correctly formatted and exists.

  • Bad request:
    "Bad request: The request was improperly formatted or contained invalid parameters."
    → Ensure the Portal ID parameter is provided and valid.

  • Forbidden:
    "Forbidden: You do not have permission to access this resource or the payment channel is not enabled for your account."
    → Confirm that the API token has sufficient permissions.

  • Not found:
    "Not found: The requested resource does not exist."
    → Double-check the Portal ID; it might be incorrect or deleted.

  • Server error:
    "Server error: The Bayarcash server encountered an error."
    → Retry later or contact Bayarcash support if persistent.

Links and References

Discussion