Log Payment

Use the Log Payment API endpoint to log a payment that has already been collected outside of the payment processing flow.

📘
Early Access
Credit API endpoints are currently being finalised as part of ongoing product development. While we do not anticipate significant changes, some interfaces, behaviours, and documentation may be refined before general availability.

The Log Payment endpoint enables you to record a payment directly against a customer's line of credit account in the system. Use this endpoint to log payments that have already been collected through an external channel, such as a cash payment made in person or a check received by mail. To schedule a payment from a bank account linked to the customer, use the Create Autopay endpoint instead.

📘
More Information
For more information about the Accounts endpoints, see: Credit Accounts.

Prerequisites

To integrate calls to the Log Payment endpoint, you need:

The account_id of the line of credit account to log the payment against. This is the Thredd Account ID, returned when a credit application is approved.
The payment amount and, optionally, the date on which the payment should be applied to the account.

Example Request

Log a payment by making a POST request to the Log Payment endpoint.

POST {{baseUrl}}/api/v1/credit/accounts/{account_id}/payment/log

Path Parameters

Parameter	Description
`account_id`	string. Required. The unique identifier of the line of credit account.

Example Payload

{
  "amount": 0,
  "description": "string",
  "applyDate": "YYYY-MM-DD"
}

{
  "amount": 250.00,
  "description": "Cash payment received in branch",
  "applyDate": "2025-02-15"
}

Request Fields

Attribute	Description
`amount`	number or string. Required. The payment amount, as a positive number with up to two decimal places.
`description`	string. Optional. A description of the payment. Maximum length is 255 characters. Defaults to `"payment"` if omitted.
`applyDate`	string. Optional. The date on which the payment applies to the account, in `YYYY-MM-DD` format.

Example Response

A successful request returns a 200 HTTP status code confirming the payment has been logged.

📘
Note
If the request contains invalid data or is incomplete, the system returns a 422 HTTP error and details of the validation failure.

{
  "isSuccess": true
}

{
  "detail": "Account mapping not found."
}

{
  "detail": [
    {
      "loc": ["body", "amount"],
      "msg": "Field required",
      "type": "missing"
    }
  ]
}

Response Fields

Attribute	Description
`isSuccess`	boolean. Indicates whether the operation was successful.

Error Messages

If there is a problem with the request, the response returns one of the following errors:

404 — The account_id provided does not match an existing account.
422 — A required field or its value is missing or invalid. The response includes details of the validation failure.

Updated 8 days ago

Did this page help you?