For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Headers
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.
Request
This endpoint expects an object.
amountintegerRequired
Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).
currencyenumRequired
Currency code (ISO 4217) indicating the currency in which the payment was made.
objectobjectRequired
Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier.
entity_user_idstringOptionalformat: "uuid"
ID of the user associated with the payment, if applicable.
paid_atdatetimeOptional
Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
payment_intent_idstringOptionalformat: "uuid"
Identifier for an payment intent.
payment_intent_statusstringOptional
Raw status string of the external payment intent.
payment_methodstringOptional
Payment method used or planned for the transaction.
planned_payment_datestringOptionalformat: "date"
Scheduled date for future payments, required when the payment is planned but not yet executed.
statusenumOptionalDefaults to succeeded
Status of the payment record indicating its current stage (e.g., created, processing, succeeded).
Allowed values:
Response
Successful Response
idstringformat: "uuid"
amountinteger
Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).
currencyenum
Currency code (ISO 4217) indicating the currency in which the payment was made.
historylist of objects
History of the payment record.
is_externalboolean
objectobject
entity_user_idstringformat: "uuid"
ID of the user associated with the payment, if applicable.
overpaid_amountinteger>=0Defaults to 0
Filled in a case, if payment amount is more, than total_amount
paid_atdatetime
Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
payment_intent_idstringformat: "uuid"
Identifier for an payment intent.
payment_intent_statusstring
Raw status string of the external payment intent.
payment_methodstring
Payment method used or planned for the transaction.
planned_payment_datestringformat: "date"
Scheduled date for future payments, required when the payment is planned but not yet executed.
statusstringDefaults to succeeded
The current status of the payment record. Possible values: created, processing, succeeded, canceled.
Errors
401
Post Payment Records Request Unauthorized Error
422
Post Payment Records Request Unprocessable Entity Error
429
Post Payment Records Request Too Many Requests Error
