Skip to main content
POST
Mark payment as paid

Overview

Manually mark a payment as paid. Use this when payment was collected outside of automated billing (e.g., bank transfer, check, cash) or to reconcile payments manually.
This endpoint is for manual reconciliation. Automated payments through integrated payment processors are marked paid automatically.

Common Use Cases

  • Bank Transfers: Customer paid via wire transfer
  • Checks: Payment received by check
  • Cash: In-person cash payment
  • External Systems: Payment collected through another system
  • Reconciliation: Fix discrepancies between systems

Request Fields

Example Request

What Happens

When you mark a payment as paid:
  1. Payment status changes to paid
  2. paidAt timestamp recorded
  3. Subscription cost recovery metrics updated
  4. Customer lifetime value updated

Example: Process Bank Transfer

Example: Bulk Reconciliation

Error Handling

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Path Parameters

paymentId
string
required

The payment ID

Body

application/json
paymentReference
string
notes
string

Response

Payment marked as paid

success
enum<boolean>
required
Available options:
true
message
string
required
payment
object
required