Reconcile a transaction to a plan

Allocates a transaction to a plan (reconciliation). By default the full remaining unreconciled amount is applied; pass amount to allocate part of it. To split-fund a plan that arrived as several credits (e.g. a $3,800 invoice as $3,650 + $150), call this endpoint once per transaction with its portion. Use is_payment=false to link a transaction as an internal transfer without creating a payment or changing the plan's collected amount. Returns the updated transaction with its reconciliation summary, allocations and payment_ids.

Path Params
string
required
Body Params

Request to allocate (reconcile) a transaction to a plan via the public API.

> 0

Portion of the transaction to allocate to this plan. Defaults to the transaction's full remaining unreconciled amount. Must be greater than zero and must not exceed the remaining unreconciled amount. To split-fund a plan across several credits, call this endpoint once per transaction with its portion.

boolean
Defaults to true

True (default) records the allocation as money collected toward the plan's balance, creating a payment. False links the transaction as an internal transfer only, without creating a payment or changing the plan's collected amount.

string
required

Plan to allocate this transaction to. Use GET /v1/plans/{plan_id} to confirm the target plan.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json