Create a new payment for a debt

post

https://api.ophelos.dev/debts/{id}/payments

Create a new payment for a debt. The payment will be applied to the debt and the debt balance will be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

ID of the debt

Query Params

expand[]

array of strings

Specify fields to expand in the response.

Multiple fields can be expanded by providing the parameter multiple times.

expand[]

Allowed:

Body Params

Payment represents the amount of money paid by the customer to the organisation.

The payments that have been made on the debt.

amount

number

required

The amount of the payment in the currency of the customer. This field represents the financial value associated with the payment and must be positive.

currency

string

enum

The currency in which the payment is denominated.

transaction_ref

string

required

The reference number for the payment transaction. This field provides a unique identifier for the payment transaction and can be used for tracking and reconciliation purposes.

transaction_at

date-time

required

The date and time when the payment transaction was processed. This field provides information about the timing of the payment transaction.

metadata

object

A set of key-value pairs that you can attach to a line item object. It can be useful for storing additional information about the debt in a structured format.

Responses

201Payment created successfully.

400Bad Request - The request could not be understood or was missing required parameters.

401Unauthorized - Authentication is needed to get the requested response.

403Forbidden - The client did not have permission to access the requested resource.

404Not Found - The requested resource was not found.

429Rate Limit Exceeded - The rate limit has been exceeded.

500Internal Server Error - An unexpected error occurred on the server.