Integrations

Integrations

Open in ChatGPT
Ask ChatGPT about this page
Open in Claude
Ask Claude about this page

The shared Payment Ledger

On a plain Frappe site, Payment Core installs three doctypes that together form the payment ledger:

Payment Transaction

One row per payment attempt. Links to any Frappe document (your "reference": an order, invoice, subscription, or custom doctype)

Lifecycle:

Key fields:

Field Description
reference_doctype / reference_docname The document being paid (any doctype)
gateway The gateway string (e.g., Stripe-GW1:Stripe-GW1)
amount / currency The chargeable amount
outstanding_amount Remaining balance after partial captures
status Current lifecycle state
checkout_url The gateway-hosted payment page URL
provider_transaction_id The gateway's transaction identifier (e.g., Stripe PaymentIntent ID)

Payment Receipt

One row per money movement (capture or refund). Submission automatically updates the transaction status.

Entry type Effect on transaction
Capture (full) Transaction → Paid, outstanding → 0
Capture (partial) Transaction → Partially Paid
Refund Transaction → Refunded (if fully offsetting)

Payment Field Mapping

Maps any doctype's fields to payment purposes (amount, buyer email, phone, etc.). This is how Payment Core knows where to read the payable amount from your custom doctype.

Forces the shared ledger on ERPNext sites

Set in site_config.json to keep the shared Payment Ledger on a site that also has ERPNext:

{
    "force_payment_ledger": 1
}
Last updated 2 weeks ago
Was this helpful?
Thanks!