CommonPayment records

Update a payment record

Path parameters

payment_record_idstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
amountintegerOptional

Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).

currencyenumOptional

Currency code (ISO 4217) indicating the currency in which the payment was made.

entity_user_idstringOptionalformat: "uuid"
ID of the user associated with the payment, if applicable.
objectobjectOptional

Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier.

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.

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
payment_intent_idstringformat: "uuid"
Identifier for an payment intent.
entity_user_idstring or nullformat: "uuid"
ID of the user associated with the payment, if applicable.
overpaid_amountinteger or null>=0Defaults to 0

Filled in a case, if payment amount is more, than total_amount

paid_atdatetime or null
Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
payment_intent_statusstring or null
Raw status string of the external payment intent.
payment_methodstring or null
Payment method used or planned for the transaction.
planned_payment_datestring or nullformat: "date"
Scheduled date for future payments, required when the payment is planned but not yet executed.
statusstring or nullDefaults to succeeded

The current status of the payment record. Possible values: created, processing, succeeded, canceled.

Errors