| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
This endpoint allows external systems to post customer payments into Alvys and apply them to the corresponding load.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| version | string | Yes | API version (e.g., 1.0) |
Request Body
Content-Type: application/json-patch+json
| Field | Type | Required | Description |
|---|---|---|---|
| LoadNumber | string | Yes | Load number the payment should be applied to |
| Amount | object | Yes | Payment amount object |
| Amount.Amount | number | Yes | Payment amount value |
| Amount.Currency | integer | Yes | Currency identifier |
| CheckNumber | string | No | Check number if the payment method uses a check |
| InvoiceNumber | string | No | Invoice number associated with the payment |
| Note | string | No | Additional note related to the payment |
| PaymentDate | string (date-time) | Yes | Date when the payment was made |
| PaymentMethod | string | No | Payment method used (for example Check, ACH, Wire) |
| ReferenceNumber | string | Yes | External reference number for idempotency and payment tracking |
Example Request
{
"LoadNumber": "string",
"Amount": {
"Amount": 0,
"Currency": 0
},
"PaymentDate": "2026-03-16T13:57:56.427Z",
"ReferenceNumber": "string",
"InvoiceNumber": "string",
"PaymentMethod": "string",
"CheckNumber": "string",
"Note": "string"
}Response Body
| Field | Type | Description |
|---|---|---|
| LoadNumber | string | Load number the payment was applied to |
| Status | string | Current load status after applying the payment |
| CustomerPayments | array | List of customer payments recorded for the load |
CustomerPayments Object
| Field | Type | Description |
|---|---|---|
| Id | string | Unique identifier of the customer payment |
| Amount | object | Payment amount object |
| Amount.Amount | number | Payment amount value |
| Amount.Currency | integer | Currency identifier |
| CheckNumber | string | Check number if applicable |
| InvoiceNumber | string | Invoice number associated with the payment |
| PaymentDate | string (date-time) | Date when the payment was recorded |
| PaymentMethod | string | Payment method used |
| ReferenceNumber | string | External reference number for the payment |
Related Load Fields Updated After Successful Payment
Successful requests also update payment fields on the related load response:
| Field | Type | Description |
|---|---|---|
| paidAt | datetime (nullable) | Timestamp when a customer payment was recorded |
| totalPaid | Money (nullable) | Total amount paid by the customer to date |
| payments | Payment[] (nullable) | Array of individual customer payment records |
Notes
-
This endpoint records customer payments against loads.
-
The request body content type exposed by the API is
application/json-patch+json. -
ReferenceNumberis required and is used for idempotency. Repeating the sameReferenceNumberfor the same load returns the original payment instead of creating a duplicate. -
Successful payment requests also populate
paidAt,totalPaid, andpayments[]on the related load. -
This endpoint accepts payments only when the load is in one of these statuses:
InvoicedCompletedFinanced
-
Loads in non-payable statuses such as
Dispatchedare rejected with:
400 Bad Request
Load must be in one of: Invoiced, Completed, Financed.- If the
LoadNumberdoes not exist, the endpoint returns:
404 Not Found- If
Amount.Amountis negative or zero, the endpoint returns:
400 Bad Request
Amount must be greater than zero.- If
ReferenceNumberis empty or omitted, the endpoint returns:
400 Bad Request
The ReferenceNumber field is required.