Log Payment

Logs a payment that has already been made toward a line of credit account, identified by the account ID. Unlike Create Autopay, this endpoint is not tied to a specific linked bank account and is intended for recording payments made outside of an automated bank transfer (for example, a payment collected through another channel).

Path parameters

  • account_id (string): The unique identifier (UUID) of the account.

Request body fields

  • 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".
  • applyDate (string, optional): The date on which the payment applies to the account, in YYYY-MM-DD format.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

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.


Path Params
string
required
Body Params

The request body for logging a payment that was made toward a line of credit account outside of an automated bank transfer.

required

The payment amount, as a positive number with up to two decimal places.

string
length ≤ 255
Defaults to payment

A description of the payment. Maximum length is 255 characters. Defaults to "payment".

date

The date on which the payment applies to the account.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json