Lectful Central icon

Lectful Central

Interact with the Lectful Central API for admin operations

Actions63

Overview

The "Create Payment" operation in the Lectful Central node allows users to create a new payment record for an existing invoice within the Lectful Central system. This is useful for automating financial workflows such as recording payments received against invoices, updating payment statuses, and tracking transaction details.

Typical scenarios include:

  • Automatically logging customer payments after successful transactions.
  • Integrating payment data from external systems into Lectful Central.
  • Managing payment records programmatically during billing or subscription processes.

For example, after receiving a payment confirmation from a payment gateway, this node can be used to create a corresponding payment entry linked to the relevant invoice, specifying the amount, currency, payment method, status, and additional metadata like references or notes.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful Central API: either using stored credentials or manual configuration by providing base URL and API key.
Base URL Override (Manual mode) Optional base URL to override the credential setting (without /api/v1).
API Key Override (Manual mode) Optional API key to override the credential setting.
Invoice ID (for Payment) The ID of the invoice to which the payment will be applied.
Payment Method ID (for Payment) The ID of the payment method used for this payment.
Payment Amount The amount of the payment.
Payment Currency The currency code for the payment amount (e.g., USD, EUR).
Payment Status The status of the payment. Options: Pending, Completed, Failed, Cancelled, Refunded.
Payment Date The date when the payment was made, in YYYY-MM-DD format.
Payment Reference Optional reference number for the payment (e.g., REF-001).
Gateway Transaction ID Optional transaction ID from the payment gateway (e.g., TXN-12345).
Payment Notes Optional additional notes about the payment.

Output

The node outputs the JSON response returned by the Lectful Central API after creating the payment. This typically includes details of the newly created payment record such as its unique ID, linked invoice ID, payment method, amount, currency, status, date, references, and any notes.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "invoice_id": 456,
  "payment_method_id": 789,
  "amount": 100.00,
  "currency": "USD",
  "status": "completed",
  "payment_date": "2024-06-01",
  "payment_reference": "REF-001",
  "gateway_transaction_id": "TXN-12345",
  "notes": "Payment received via credit card"
}

Dependencies

  • Requires access to the Lectful Central API.
  • Authentication can be provided either via stored credentials configured in n8n or manually by specifying the base URL and API key.
  • The node expects the Lectful Central API to be reachable at the specified base URL.
  • Proper permissions are required on the API key or credentials to create payments.

Troubleshooting

  • Missing or invalid credentials: If neither stored credentials nor manual overrides are properly set, the node will throw an error indicating that valid credentials are required.
  • Base URL or API key missing in manual mode: When using manual authentication mode, both the base URL override and API key override must be provided; otherwise, an error is thrown.
  • Invalid input data: Required fields such as invoice ID, payment method ID, amount, currency, status, and payment date must be provided; missing these will cause the API request to fail.
  • API errors: Errors returned by the Lectful Central API (e.g., invalid invoice ID, unauthorized access) will be surfaced in the node's output. Check the error message for details.
  • Date format issues: Ensure the payment date is in YYYY-MM-DD format to avoid validation errors.

Links and References

Discussion