Mark Payment Paid - FlexPortal

Mark payment as paid

curl --request POST \
  --url https://api-eu.flexportal.io/v1/payments/{paymentId}/mark-paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "paymentReference": "<string>",
  "notes": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "payment": {
    "paymentId": "<string>",
    "tenantId": "<string>",
    "customerId": "<string>",
    "subtotal": 1,
    "total": 1,
    "currency": "<string>",
    "billingPeriod": "<string>",
    "idempotencyKey": "<string>",
    "dueDate": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "taxAmount": 0,
    "taxRate": 0,
    "amount": 1,
    "rentalId": "<string>",
    "billingGroupId": "<string>",
    "transactionId": "<string>",
    "providerResponse": {},
    "manuallyMarked": false,
    "paymentReference": "<string>",
    "markedBy": "<string>",
    "captureAttempts": 0,
    "lastCaptureError": {
      "code": "<string>",
      "message": "<string>",
      "declineCode": "<string>"
    },
    "lineItems": [
      {
        "rentalId": "<string>",
        "description": "<string>",
        "amount": 1,
        "taxAmount": 0
      }
    ],
    "lateFeeApplied": false,
    "lateFeeAmount": 1,
    "originalAmount": 1,
    "notes": "<string>",
    "paidAt": "<string>",
    "lastCaptureAttempt": "<string>",
    "nextRetryAt": "<string>"
  }
}

POST

payments

{paymentId}

mark-paid

Mark payment as paid

curl --request POST \
  --url https://api-eu.flexportal.io/v1/payments/{paymentId}/mark-paid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Tenant-ID: <tenant-id>' \
  --data '
{
  "paymentReference": "<string>",
  "notes": "<string>"
}
'

{
  "success": true,
  "message": "<string>",
  "payment": {
    "paymentId": "<string>",
    "tenantId": "<string>",
    "customerId": "<string>",
    "subtotal": 1,
    "total": 1,
    "currency": "<string>",
    "billingPeriod": "<string>",
    "idempotencyKey": "<string>",
    "dueDate": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "taxAmount": 0,
    "taxRate": 0,
    "amount": 1,
    "rentalId": "<string>",
    "billingGroupId": "<string>",
    "transactionId": "<string>",
    "providerResponse": {},
    "manuallyMarked": false,
    "paymentReference": "<string>",
    "markedBy": "<string>",
    "captureAttempts": 0,
    "lastCaptureError": {
      "code": "<string>",
      "message": "<string>",
      "declineCode": "<string>"
    },
    "lineItems": [
      {
        "rentalId": "<string>",
        "description": "<string>",
        "amount": 1,
        "taxAmount": 0
      }
    ],
    "lateFeeApplied": false,
    "lateFeeAmount": 1,
    "originalAmount": 1,
    "notes": "<string>",
    "paidAt": "<string>",
    "lastCaptureAttempt": "<string>",
    "nextRetryAt": "<string>"
  }
}

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

Field	Required	Description
`paidAt`	No	When payment was received (default: now)
`notes`	No	Notes about the payment
`reference`	No	External reference (bank ref, check number)

Example Request

{
  "paidAt": "2025-01-15T10:30:00Z",
  "reference": "WIRE-2025-001234",
  "notes": "Received via bank transfer"
}

What Happens

When you mark a payment as paid:

Payment status changes to paid
paidAt timestamp recorded
Subscription cost recovery metrics updated
Customer lifetime value updated

Example: Process Bank Transfer

async function recordBankTransfer(paymentId, bankReference, transferDate) {
  return await markPaymentPaid(paymentId, {
    paidAt: transferDate,
    reference: bankReference,
    notes: 'Manual reconciliation - bank transfer'
  });
}

// Usage
await recordBankTransfer('pay_abc123', 'TRF-2025-001234', '2025-01-15T10:30:00Z');

Example: Bulk Reconciliation

async function reconcilePayments(reconciliationData) {
  const results = { success: 0, errors: [] };

  for (const item of reconciliationData) {
    try {
      await markPaymentPaid(item.paymentId, {
        paidAt: item.paidDate,
        reference: item.bankReference
      });
      results.success++;
    } catch (error) {
      results.errors.push({
        paymentId: item.paymentId,
        error: error.message
      });
    }
  }

  return results;
}

Error Handling

Error Code	Cause	Solution
`NOT_FOUND`	Payment doesn’t exist	Verify payment ID
`ALREADY_PAID`	Payment already marked as paid	No action needed
`PAYMENT_CANCELLED`	Cannot mark cancelled payment as paid	Payment is final

Get Payment - Check current status
List Payments - Find payments to reconcile
Cancel Payment - Cancel instead of paying

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

Show child attributes

Get Payment Cancel Payment

​Overview

​Common Use Cases

​Request Fields

​Example Request

​What Happens

​Example: Process Bank Transfer

​Example: Bulk Reconciliation

​Error Handling

​Related Endpoints

Authorizations

Headers

Path Parameters

Body

Response

Overview

Common Use Cases

Request Fields

Example Request

What Happens

Example: Process Bank Transfer

Example: Bulk Reconciliation

Error Handling

Related Endpoints