Bizappay icon

Bizappay

Interact with Bizappay API

Actions13

Overview

This node integrates with the Bizappay API to manage payment-related operations, specifically focusing on retrieving detailed information about payment banks. The "Get by Code" operation under the "Payment Bank" resource allows users to fetch details of a specific bank by its unique code from the list of available payment banks.

Common scenarios where this node is beneficial include:

  • Validating or displaying bank details in payment workflows.
  • Automating financial processes that require bank-specific information.
  • Integrating with payment gateways that need bank metadata for processing transactions.

For example, if you have a payment system that supports multiple banks, you can use this node to retrieve and verify bank details dynamically based on user selection or other logic.

Properties

Name Meaning
Bank Name or ID Select a bank from the available payment banks by name and code. You can choose from a dropdown list loaded dynamically or specify a bank code using an expression.

Output

The output JSON contains the details of the requested bank matching the specified bank code. The structure typically includes fields such as:

  • name: The full name of the bank.
  • code: The unique code identifier of the bank.
  • status: The current status of the bank (e.g., active, inactive).

If the bank code does not match any bank in the retrieved list, the node throws an error indicating the bank was not found.

No binary data is output by this operation.

Example output JSON snippet:

{
  "name": "Example Bank (EXB)",
  "code": "EXB",
  "status": "active"
}

Dependencies

  • Requires an API key credential for authenticating requests to the Bizappay API.
  • The node uses the /payment-bank-list endpoint of the Bizappay API to fetch the list of banks.
  • No additional external dependencies are required beyond the configured API credentials.

Troubleshooting

  • Bank Not Found Error: If the specified bank code does not exist in the fetched bank list, the node will throw an error like Bank with code XYZ not found. Ensure the bank code is correct and matches one from the available options.
  • Failed to Retrieve Bank List: If the node cannot fetch the bank list from the API, it throws an error Failed to retrieve bank list. This could be due to network issues, invalid API credentials, or API downtime. Verify your API key and network connectivity.
  • Invalid Bank Code Input: Make sure the bank code parameter is provided and valid. Using expressions incorrectly may cause errors.
  • API Authentication Issues: If authentication fails, ensure the API key credential is correctly set up and has necessary permissions.

Links and References

Discussion