Bayarcash icon

Bayarcash

Consume Bayarcash API

Actions6

Overview

This node interacts with the Bayarcash API to manage payment intents, specifically allowing users to retrieve the status of a payment intent. The "Get Status" operation fetches the current state of a specified payment intent by its ID.

Common scenarios where this node is beneficial include:

  • Monitoring the progress or completion of a payment initiated through Bayarcash.
  • Automating workflows that depend on payment confirmation or status updates.
  • Integrating payment status checks into broader business processes such as order fulfillment or customer notifications.

For example, after creating a payment intent elsewhere in your workflow, you can use this node to periodically check if the payment has succeeded, failed, or is still pending, and then trigger subsequent actions accordingly.

Properties

Name Meaning
Payment Intent ID The unique identifier of the payment intent whose status you want to retrieve (e.g., pi_Yd7wpD). This is a required string input.
This payment intent status endpoint is only available in Bayarcash API v3 A notice informing that the "Get Status" operation requires Bayarcash API version 3.

Output

The node outputs JSON data representing the details of the requested payment intent, including its current status. The exact structure depends on the Bayarcash API response but typically includes fields such as:

  • id: The payment intent ID.
  • status: Current status of the payment intent (e.g., new, pending, success, failed).
  • Other metadata related to the payment intent like amount, payer information, timestamps, etc.

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 Bayarcash API base URL and PAT token must be configured in the node credentials.
  • The "Get Status" operation is only supported when using Bayarcash API version 3.

Troubleshooting

Common Issues

  • Authentication failures: If the PAT token is invalid or expired, the node will return an authentication error.
  • Invalid Payment Intent ID: Providing a non-existent or malformed payment intent ID will result in a "Not found" error.
  • API version mismatch: Attempting to use this operation with an unsupported API version may cause errors or unexpected behavior.

Error Messages and Resolutions

  • Authentication failed: Invalid or expired PAT token. Please check your credentials.
    Ensure your Bayarcash API credentials are correct and the token is not expired. Re-authenticate if necessary.

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

  • Bad request: The request was improperly formatted or contained invalid parameters.
    Verify all input parameters, especially the payment intent ID.

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

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

  • Server error: The Bayarcash server encountered an error.
    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