Bayarcash icon

Bayarcash

Consume Bayarcash API

Actions6

Overview

This node integrates with the Bayarcash API to retrieve detailed information about a specific transaction by its unique ID. It is particularly useful in scenarios where you need to verify payment details, track transaction status, or audit financial records within automated workflows.

Practical examples include:

  • Fetching transaction details after a payment event to update order status.
  • Validating transaction authenticity before fulfilling an order.
  • Integrating transaction data into CRM or accounting systems for reconciliation.

Properties

Name Meaning
Transaction ID The unique identifier of the transaction to retrieve (e.g., trx_z88ymJ). This is required.

Additionally, there is a notice property indicating that these transaction endpoints are only available in Bayarcash API version 3.

Output

The node outputs JSON data representing the full details of the requested transaction as returned by the Bayarcash API. The structure typically includes fields such as transaction ID, status, amount, payer information, payment channel, timestamps, and other metadata related to the transaction.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Bayarcash API credential with a valid personal access token (PAT) for authentication.
  • The node makes HTTP GET requests to the Bayarcash API endpoint /transactions/{transactionId}.
  • The Bayarcash API v3 must be used, as the transaction endpoints are only available in this version.
  • Proper configuration of the API URL and PAT token in the credentials is necessary.

Troubleshooting

Common issues and error messages:

  • Authentication failed: "Invalid or expired PAT token."
    Resolution: Verify and update your Bayarcash API credentials to ensure the token is valid.

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

  • Bad request: "The request was improperly formatted or contained invalid parameters."
    Resolution: Ensure all required parameters are provided and correctly typed.

  • Forbidden: "You do not have permission to access this resource or the payment channel is not enabled for your account."
    Resolution: Confirm your API key has sufficient permissions and the account is properly configured.

  • Not found: "The requested resource does not exist."
    Resolution: Verify the Transaction ID is correct and the transaction exists in Bayarcash.

  • Server error: "The Bayarcash server encountered an error."
    Resolution: Retry later or contact Bayarcash support if the issue persists.

If the node is set to continue on failure, errors will be returned as JSON objects containing the error message, HTTP status code, and timestamp.

Links and References

Discussion