paywise icon

paywise

Consume paywise API

Actions20

Overview

This node integrates with the Paywise API, specifically allowing users to manage and retrieve data related to companies via the Partner API. The "Get" operation for the "Company" resource fetches detailed information about a specific company by its ID. This is useful in scenarios where you need to access company details programmatically within an n8n workflow, such as syncing company data, verifying company information before processing transactions, or enriching datasets with company metadata.

Practical example:
You have a workflow that processes incoming orders and needs to verify the company details of the customer placing the order. Using this node's "Get Company" operation, you can retrieve the company's information by its ID and use it downstream for validation or reporting.

Properties

Name Meaning
Company ID The ID of the company to retrieve. This should be a string representing the unique identifier of the company in the Paywise system.

Output

The node outputs JSON data containing the details of the requested company. The exact structure depends on the Paywise API response but typically includes fields such as company name, address, contact information, status, and other relevant metadata.

If the node supports binary data output (not indicated here), it would represent any associated files or documents related to the company, but based on the provided code and properties, the output is purely JSON.

Dependencies

  • Requires an active connection to the Paywise API using an API key credential configured in n8n.
  • The node depends on the Paywise Partner API being accessible and the user having appropriate permissions to retrieve company data.
  • No additional external dependencies are indicated beyond the Paywise API.

Troubleshooting

  • Common issues:

    • Invalid or missing Company ID: Ensure the Company ID provided is correct and exists in the Paywise system.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network or API downtime: Check connectivity to the Paywise API endpoint.
  • Error messages:

    • "Resource "company" is not implemented": This indicates a misconfiguration or typo in the resource parameter; ensure "company" is selected.
    • "Operation "get" for resource "company" is not implemented": Indicates the operation is not recognized; confirm the operation name is exactly "get".
    • Other errors from the API will be passed through; check the error message for details such as invalid ID or permission denied.

Links and References

Discussion