Payment records are a way to track the payment history of payables (bills) and accounts receivable invoices. The /payment_records endpoint allows you to take note of every payment made towards a payable or an invoice.
If you use Monite payment rails together with account payables or accounts receivable, Monite automatically stores all payment information for payables and receivable invoices. However, when using external payment rails, you must manually create records for each payment instance - full or partial - made towards invoices.
To use the /payment_records* endpoints with an entity user token, this entity user must have a role with the payment_record permission.
If using a partner-level token, no special permissions are needed.
There are two types of payment records:
Monite-created payment records - These are created automatically for all payments made via the Monite payment links. Each payment intent gets an associated payment record that is used to reconciliate this payment with the related payable or receivable invoice.
Monite-created payment records have the is_external field set to false.
These payment records can only be retrieved, but not modified directly by users.
External payment records - can be created and updated by the entity. These are intended for entities that use their own payment rails, and are meant to record information about full or partial payments made via external channels.
External payment records can have different statuses to mirror the payment procesing status from external systems. They can also store information about future scheduled payments.
Entities that use Monite payment rails can also create external payment records to reflect payments made outside the Monite platform.
To get a list of all payment records, call GET /payment_records:
The successful request returns a paginated history of all payment records—both Monite-created and external.
To get only Monite-created or only external payment records, use the is_external query parameter.
For example, the following snippet returns only payment records created using Monite payment rails:
You can sort and filter the results of this request by invoice type (payable or receivable), payment record status, and other parameters.
For the full list of available sort and filter parameters, see the description of the GET /payment_records endpoint.
To find all payment records associated with a specific payable or receivable invoice, call GET /payment_records and specify the invoice ID in the object_id query parameter:
External payment records are allocated with a status that indicates their progress in the external payment system.
createdThis is the status for draft payment records that are created manually.
The payment record exists and is linked to an invoice but has not been applied yet, so it does not affect the invoice’s status or amount due.
Payment records in the created status can be fully edited.
processingThis status is used for payments that are being processed by the bank or financial institution.
To move the payment record to this status, call POST /payment_records.
Payment records in the processing status cannot be modified but is still not applied to the invoice.
You must manually move it to succeeded or canceled status once the external payment completes.
succeededThis is a final status that indicates successful payments and sucessful refunds.
To move a payment record to this status, call POST /payment_records passing the paid_at field in the body request.
Succeeded payment records modify the amount due and status of the linked invoice:
amount_paid and reduce the amount_due.amount_paid and increase the amount_due.canceledPayment records in the created and processing statuses can be canceled.
Once canceled, the payment record will not be applied to the invoice and cannot be modified further.
This is a final status.
To create a payment record for a payable or receivable invoice, call POST /payment_records with the following request fields:
object.type - the invoice type (payable or receivable) for which the payment was made.object.id - ID of the payable or receivable invoice.amount and currency - use a positive amount value for payments made toward the invoice, and negative values for refunds.created status that indicate future scheduled payments:
planned_payment_date - scheduled date for a future payment, required when the payment is planned but not yet executed.succeeded status:
paid_at - date and time when the payment was made.payment_intent_id - the external payment reference number or transaction ID for the payment.
Required for records in the processing and succeeded statuses.
Currently payment_intent_id must be a UUID, you can use a random UUID.Additional optional fields:
status - the status of the payment record.
You can create records in the created, processing, or succeeded status.
If omitted, defaults to succeeded.payment_intent_status - the status of the corresponding payment or payment intent in the partner’s payment rails. A user-defined string.payment_method - payment method used or planned for the transaction. A user-defined string.The response also contains a unique id assigned to this payment record.
Monite automatically updates the status of the specified invoice to reflect the payment made and returns the old and new statuses in the response:
External payment records in the created status can be manually canceled or updated:
PATCH /payment_records/{payment_record_id}.created or processing statuses, call POST /payment_records/{payment_record_id/cancel}.
Succeeded payment records cannot be canceled.If a succeeded payment record has been refunded, you can record the refund by creating a new payment record with a negative value in the amount field.
This reduces the invoice’s amount_paid, increase the amount_due, and also updates the invoice’s status if needed.
Scheduled external payment records represent invoice payments that are planned but not yet made. The payment can be full or partial.
Monite does not trigger payments based on scheduled payment records. The payment is supposed to be made by the entity itself via their preferred channel. The purpose of scheduled payment records is to record the fact that the payment is planned, and to mirror the payment status from the external system so that Monite can reconciliate the external payment with the associated invoice.
To create a schedule payment, call POST /payment_records and provide the following fields in addition to the required ones:
status - set to created,planned_payment_date - use the YYYY-MM-DD format,payment_method - (optional) a user-defined identifier of the payment method that will be used, for example, bank_transfer, card, or cash.The created payment record has the created status and will not affect the invoice’s status or amounts until it’s marked as succeeded.
While a scheduled payment record is still in the created status and has not started processing, you can update its details in Monite: amount, planned_payment_date, payment_method, and other fields.
To update the scheduled payment details, call PATCH /payment_records.
When a scheduled payment begins processing in your external system, call POST /payment_records to move the corresponding payment record to the processing status.
In the request body, you can optionally provide the payment_intent_status field containing the payment status in the external system (as an arbitrary user-defined string):
While a payment record is in the processing status, the invoice status and amounts are still not updated until the payment is marked as succeeded.
When the external payment succeeds, call POST /payment_records to apply the payment to the invoice.
In the request body, provide the paid_at value and, optionally, the new external payment_intent_status:
This moves the payment record to succeeded status and updates the invoice’s amount_paid, amount_due, and status accordingly.
To cancel a scheduled payment that hasn’t been executed, call POST /payment_records.
You can cancel payment records in the created and processing statuses.