Public API Carrier & Customer Payments Enhancements

What’s New?

We’ve introduced new Public API capabilities for carrier payments, customer payments, and financing transactions. These additions make it easier for external payment platforms, factoring providers, and finance systems to sync financial activity directly with Alvys.

What Changed?

Previously, the Public API did not provide dedicated endpoints for recording these financial transactions.

Now, the API includes the following new endpoints:

POST /p/v1.0/invoices/carrier-payments
POST /p/v1.0/invoices/customer-payments
POST /p/v1.0/invoices/financing

Carrier Payments

Records a payment made to a carrier for a trip.

Example:

{
  "tripId": "string",
  "amount": {
    "value": 1000.00,
    "currency": "USD"
  }
}

Updates trip payment fields such as carrierPaidAt.

Customer Payments

Records a payment received from a customer for a load.

Example:

{
  "loadId": "string",
  "amount": {
    "value": 2500.00,
    "currency": "USD"
  }
}

Updates load payment details such as:

• paidAt
• totalPaid
• payments[]

Financing

Records financing activity such as reserve or escrow amounts for a load.

Example:

{
  "loadId": "string",
  "reserveAmount": {
    "value": 500.00,
    "currency": "USD"
  },
  "escrowAmount": {
    "value": 200.00,
    "currency": "USD"
  }
}

Endpoints Affected:

• POST /p/v1.0/invoices/carrier-payments
• POST /p/v1.0/invoices/customer-payments
• POST /p/v1.0/invoices/financing

Why?

These enhancements provide:

• Faster integration with payment and finance platforms
• Better automation for receivables and payables
• Support for factoring and escrow workflows
• Reduced manual entry of financial transactions
• Improved accounting visibility across loads and trips

This update expands the Public API’s financial integration capabilities while maintaining backward compatibility.