M. Freight payment: collect carrier invoices by card

Build a freight payment flow that collects approved carrier invoices by card. Record the invoice after delivery and charge approval, then create a FRAGMENT Payment. Embedded checkout collects the shipper's payment, while FRAGMENT posts settlement and fee accounting against the invoice receivable.

Use the Quickstart to configure your SDK and create a Ledger with the example schema. Use carrier as its ik. Configure a Payment Account before collecting payments. The schema marks assets/payments with payment: { "enabled": true }.

The receivable records an approved, earned invoice. Settlement reduces the outstanding amount without recognizing that income twice. Processing fees are a separate expense.

Confirm delivery evidence, agreed rates, and approved accessorial charges before creating the invoice and Payment. Post the approved invoice once before creating its Payment. The entry records the receivable and earned income. Your accounting policy determines the recognition date. Use the AddLedgerEntry mutation with these variables.

{
  "ik": "freight_invoice_approve-1-v1",
  "entry": {
    "ledger": {
      "ik": "carrier"
    },
    "type": "freight_invoice_approve",
    "typeVersion": 1,
    "parameters": {
      "invoice_id": "1",
      "amount": "10000"
    }
  }
}

Add freight_invoice to payments.types in your Schema. Its payment.amount reads the server-approved amount. Add the settlement accounting below to these fields; the complete schema contains both.

{
  "type": "freight_invoice",
  "typeVersion": 1,
  "status": "active",
  "payment": {
    "amount": "{{amount}}",
    "direction": "payin"
  }
}

Set accounting.settled.lines to these four lines. FRAGMENT supplies settled_amount and fragment_fee_amount; your application supplies invoice_id. The shipper receives credit for the gross amount. The Payment Account receives that amount less the processing fee.

[
  {"key": "settlement", "account": {"path": "assets/payments"}, "amount": "{{settled_amount}}", "system": "payment_settlement_line"},
  {"key": "fee", "account": {"path": "assets/payments"}, "amount": "-{{fragment_fee_amount}}", "system": "payment_fee_line"},
  {"key": "receipt", "account": {"path": "assets/receivables:{{invoice_id}}/outstanding"}, "amount": "-{{settled_amount}}"},
  {"key": "fee-expense", "account": {"path": "expenses/payment-fees"}, "amount": "{{fragment_fee_amount}}"}
]

Resolve the approved freight invoice, payer, and amount from authenticated application records. Call createPayment with a stable idempotency key. Amounts are integer strings in USD cents. Return the Payment to your frontend; keep API credentials on your server.

const { createPayment } = await fragment.createPayment({
  ik: 'freight_invoice-1-v1',
  ledgerIk: 'carrier',
  type: 'freight_invoice',
  typeVersion: 1,
  parameters: { invoice_id: '1', amount: '10000' },
});
if (createPayment.__typename !== 'CreatePaymentResult') {
  throw new Error(createPayment.message);
}
return { payment: createPayment.payment };

Mount Checkout inside PaymentElements from @fragment-dev/payment-elements. Pass the Payment returned by your backend and the payer's email. The Payment starts in needs_payment_method. Your Pay button calls confirm() to charge the card.

Place checkout in the freight invoice screen. Use onConfirmed to update that screen. Verify the Payment's settled status on your backend before marking the receipt available.

import { Checkout, PaymentElements, type Payment } from '@fragment-dev/payment-elements';
import { PayButton } from './PayButton';

type Props = { payment: Payment; email: string; onConfirmed: () => void };

export const PaymentCheckout = ({ payment, email, onConfirmed }: Props) => (
  <PaymentElements>
    <Checkout
      payment={payment}
      billingDetails={{ email }}
      onConfirmed={onConfirmed}
      onError={(message) => console.error(message)}
    >
      <PayButton />
    </Checkout>
  </PaymentElements>
);

Disable the Pay button until checkout can confirm the Payment. Show errors beside the form so the customer can correct their card details.

import { usePayment } from '@fragment-dev/payment-elements';

export const PayButton = () => {
  const { confirm, canConfirm, isConfirming, isLoading, error } = usePayment();
  return <>
    <button type="button" disabled={isLoading || !canConfirm || isConfirming}
      onClick={() => canConfirm && confirm()}>Pay by card</button>
    {error && <p role="alert">{error}</p>}
  </>;
};

FRAGMENT posts settlement accounting automatically. Your application posts the separate business entry after authorization. Do not submit native settlement entries through addLedgerEntry.

These diagrams show a $100 approved invoice followed by its $100 card payment. The assumed $3 fee illustrates accounting; it is not a pricing quote. FRAGMENT supplies the actual fee. Only freight_invoice_approve is posted by your application.

Store the Payment identifier with the freight invoice and operation key. A client callback alone does not establish settlement. Recover server-side status when the response is lost.

Serialize collection attempts and cap each payment at the approved invoice balance. Payment settlement accounting does not enforce that collection limit. Bind the payer, Ledger, record, and amount on your server. The application contract records these checks.

Confirm delivery evidence, agreed rates, and approved accessorial charges before creating the invoice and Payment. Keep those decisions in the carrier's application and pass only approved identifiers and amounts to FRAGMENT.

Use a sandbox Ledger and the documented test cards. Compare actual entries with the illustrative snapshots. The snapshots do not execute checkout or prove settlement.

1. Post the approved invoice once, then collect it through checkout.
2. Verify the Payment status, gross receipt, fee expense, and remaining balance.
3. Retry with the same key and verify that the operation does not duplicate its financial effect.
4. Test a decline, a lost response, and concurrent collection requests.

1. A 
   Make Payments: Payment Types and embedded checkout
2. B 
   Quickstart: SDK and Ledger setup
3. C 
   Posting Ledger Entries
4. D 
   Payment schema
5. E 
   Illustrative accounting results
6. F 
   Payment and Ledger Entry request variables
7. G 
   Application contract