VRPlatformVRPlatform
Integrate & Migrate Data

Lynbrook Deposit Imports

Convert Lynbrook settlements into VRPlatform deposit transactions

Last Updated: 2026-07-21

Version: 1.0

Use one Lynbrook settlement as the boundary for one VRPlatform deposit. Payments, merchant fees, refunds, reversals, reversal fees, and adjustments become separate deposit lines.

Result

For each settlement with non-zero activity, submit one deposit with:

  • the Lynbrook settlement ID as uniqueRef
  • effectiveOn as the transaction date
  • the team's configured lowercase default currency
  • bankLastFour as matchBankAccountLast4, when present
  • one or more lines for every supported settlement activity collection

Lynbrook settlement values in this composition are already integer minor units. Do not multiply them by 100. Round numeric strings to the nearest integer minor unit.

Lynbrook Data to Load

Load settlements for each effective date in the target range. A settlement may contain these collections:

  • payments
  • refunds
  • reversals
  • adjustments

Use settlement.id as identity. When it is absent, use a deterministic effective-date and row-index identity, and ensure the source ordering is stable.

Map Payments and Fees

For a payment, read amount, falling back to settlementAmount. Skip it only when both values are zero.

Create the payment line with classification lynbrook_payment and the original payment amount. Then calculate:

merchant fee = settlementAmount - amount

When non-zero, create a lynbrook_paymentFee line. The result is normally negative because the net settlement amount is lower than the payment amount.

Map Refunds, Reversals, and Adjustments

Source activityAmount ruleClassification
RefundForce non-zero amount negativelynbrook_refund
ReversalForce non-zero amount negativelynbrook_reversal
Reversal feeForce non-zero fee negativelynbrook_reversalFee
AdjustmentPreserve source signlynbrook_adjustment

Do not invert negative adjustments. Their source sign carries the settlement meaning.

Reservation Matching

Choose a reservation reference from the first available field:

  1. reservationId
  2. integrationId
  3. groupIntegrationId
  4. an OwnerRez reference in description

For an OwnerRez value matching ORB plus at least six alphanumeric characters, remove the ORB prefix. Send the result as matchReservationConfirmationCode.

Fee lines inherit their parent payment or reversal reservation reference.

Descriptions and Identity

Use the source description, then customer full name, then Lynbrook ${activityType}. Build line identities with the activity kind and source id or refId, adding a deterministic suffix for duplicates.

Use settlement.bankLastFour only as a destination-bank match. Keep settlement.bankName as source metadata.

Reconciliation

Compare:

sum(all mapped lines) = settlement.amount

The current composition records both values but does not add a balancing line. Treat a mismatch as an incomplete or semantically different settlement and review it before posting.

End-to-End Example

{
  "id": 44,
  "effectiveOn": "2026-02-14",
  "amount": 1050,
  "bankLastFour": "4321",
  "payments": [
    {
      "id": 10,
      "amount": 1500,
      "settlementAmount": 1400,
      "reservationId": "ORB16108165"
    }
  ],
  "refunds": [{ "id": 11, "amount": 300, "reservationId": "ORB16108165" }],
  "adjustments": [{ "id": 13, "amount": -50, "description": "Processor fee" }]
}
{
  "connectionId": "00000000-0000-0000-0000-000000000002",
  "data": [
    {
      "type": "deposit",
      "currency": "usd",
      "date": "2026-02-14",
      "description": "Lynbrook settlement 44",
      "uniqueRef": "44",
      "matchBankAccountLast4": "4321",
      "lines": [
        {
          "uniqueRef": "payment-10",
          "amount": 1500,
          "description": "Lynbrook payment",
          "matchReservationConfirmationCode": "16108165",
          "matchLineTypeClassification": "lynbrook_payment"
        },
        {
          "uniqueRef": "payment-fee-10",
          "amount": -100,
          "description": "Merchant Fee",
          "matchReservationConfirmationCode": "16108165",
          "matchLineTypeClassification": "lynbrook_paymentFee"
        },
        {
          "uniqueRef": "refund-11",
          "amount": -300,
          "description": "Lynbrook refund",
          "matchReservationConfirmationCode": "16108165",
          "matchLineTypeClassification": "lynbrook_refund"
        },
        {
          "uniqueRef": "adjustment-13",
          "amount": -50,
          "description": "Processor fee",
          "matchLineTypeClassification": "lynbrook_adjustment"
        }
      ]
    }
  ]
}

Implementation Checklist

  • Treat Lynbrook amounts as integer minor units.
  • Use the settlement ID and effective date as stable header fields.
  • Derive payment fees from settlement amount minus payment amount.
  • Force refunds, reversals, and reversal fees negative.
  • Preserve adjustment signs.
  • Strip only recognized OwnerRez ORB prefixes.
  • Reconcile the line sum to the settlement amount without an adjustment line.

On this page