Record Invoice Payment

chargebee.record_invoice_payment
ActionCRM & salesconnection required

Calls the Chargebee API with the connection's credentials.

Record a payment that was taken outside Chargebee against an invoice.

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
Chargebee
Secret shape
the site API key: the raw string, {"api_key": "…"}, or the HTTP Basic pair {"username": "<api key>", "password": ""}
Config it needs
site, base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
invoice_id
The Chargebee invoice id.
stringYes———
transaction
The offline payment, as a JSON object with Chargebee's transaction keys, e.g. {"amount": 2000, "payment_method": "bank_transfer", "date": 1612800517}.
objectYes—≥ 1 characters{"amount":2000,"date":1612800517,"payment_method":"bank_transfer"}
comment
An internal note recorded against the invoice in the Chargebee UI. It is never shown to the customer.
stringNo—≤ 300 characters—
idempotency_key
A unique value sent as 'chargebee-idempotency-key' so a retry inside Chargebee's 30-minute window replays the first response instead of charging or creating twice.
stringNo—≤ 100 characters—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "transaction": {
    "amount": 2000,
    "date": 1612800517,
    "payment_method": "bank_transfer"
  }
}

Output

One shape.

result

FieldTypeExample
invoice
The invoice resource as Chargebee returned it.
object—
transaction
The payment Chargebee attempted or recorded; read its 'status' before treating the invoice as settled.
object—
{
  "invoice": {},
  "transaction": {}
}

Notes

  • The Chargebee site and API key come from the connection; every path below is relative to https://<site>.chargebee.com/api/v2.
  • POST /invoices/{invoice-id}/record_payment

See Record Invoice Payment run in a workflow.

In a technical demo we add the Chargebee connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.