Partially icon

Partially

Partially Payment Plans API

Actions37

Overview

This node integrates with the Partially Payment Plans API to manage various payment-related resources such as customers, payment plans, offers, payments, refunds, and disputes. Specifically, for the Payment resource with the Get operation, it retrieves detailed information about a specific payment by its unique identifier.

Common scenarios where this node is beneficial include:

  • Fetching payment details to verify transaction status or amounts.
  • Integrating payment data retrieval into automated workflows for accounting or customer service.
  • Auditing or reconciling payments within broader financial processes.

For example, you might use this node to get the details of a payment after a customer completes a checkout process, enabling your system to update order statuses or trigger notifications.

Properties

Name Meaning
Payment ID The unique identifier of the payment to retrieve. This is a required string input.

Output

The node outputs an array of JSON objects representing the retrieved payment(s). For the "Get" operation on the Payment resource, the output JSON contains detailed information about the specified payment, including but not limited to:

  • Payment identifiers
  • Associated payment plan IDs
  • Amounts and currency
  • Status and timestamps
  • Related metadata

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Partially Payment Plans API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The node uses internal helper functions to make HTTP requests to the Partially API endpoints.

Troubleshooting

  • Missing or invalid Payment ID: Ensure that the "Payment ID" property is provided and correctly formatted. The node requires this to fetch the payment.
  • Authentication errors: Verify that the API key or token credential is correctly set up and has sufficient permissions.
  • Network or API errors: Check network connectivity and the availability of the Partially API service.
  • Unexpected response structure: If the API changes, the node's output format may differ; review API documentation for updates.

Common error messages typically relate to invalid parameters, unauthorized access, or resource not found. Resolving these usually involves verifying inputs and credentials.

Links and References

Discussion