Bizappay icon

Bizappay

Interact with Bizappay API

Actions13

Overview

This node integrates with the Bizappay API to manage various billing and payment-related operations. Specifically, for the Payment Status - Get Status operation, it retrieves the current payment status of a specified bill by its Bill ID. This is useful in scenarios where you want to programmatically check if a bill has been paid, is pending, or has any other payment state.

Practical examples include:

  • Automatically checking payment status after sending a bill to a customer.
  • Triggering follow-up actions based on whether a payment was completed or overdue.
  • Integrating payment status checks into larger workflows such as accounting or notification systems.

Properties

Name Meaning
Bill ID The unique identifier of the bill whose payment status you want to retrieve.

Output

The output JSON contains details about the payment status of the specified bill. It typically includes:

  • status: The current payment status (e.g., paid, pending).
  • amount: The amount associated with the payment.
  • paymentMethod: The method used for payment, if available.
  • paidAt: Timestamp when the payment was made, or indication if not yet paid.

Additionally, the node adds a summary object under _summary with these key details for easy access in subsequent workflow steps.

Example output structure:

{
  "status": "paid",
  "amount": "RM 100.00",
  "paymentMethod": "Credit Card",
  "paidAt": "2024-01-15 10:30:00"
}

Dependencies

  • Requires an active connection to the Bizappay API using an API key credential configured in n8n.
  • The node uses HTTP POST requests to communicate with the Bizappay endpoints.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Bill ID will cause the API request to fail.
    • Network or authentication errors if the API key is invalid or expired.
    • Unexpected response format if the API changes or returns errors.

  • Error messages:

    • "Bill ID is required": Ensure the Bill ID property is set and not empty.
    • "Bank with code ... not found": Not applicable here but indicates lookup failures in other operations.
    • API errors returned from Bizappay are wrapped and surfaced as node errors; check the error message for details.

  • Resolution tips:

    • Verify the Bill ID is correct and exists in Bizappay.
    • Confirm API credentials are valid and have necessary permissions.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion