---
title: "Update a payment record"
method: PATCH
path: "/payment_records/{payment_record_id}"
tags: ["Payment records"]
---

# Update a payment record

`PATCH /payment_records/{payment_record_id}`

## Request

- Base URL: `https://api.sandbox.monite.com/v1`
- URL: `https://api.sandbox.monite.com/v1/payment_records/{payment_record_id}`
- Auth: HTTP bearer

## Path parameters

- `payment_record_id` string, required

## Headers

- `x-monite-version` string, required
- `x-monite-entity-id` string, required

## Request body

- object
  - `amount` integer: Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).
  - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW'
  - `entity_user_id` string, uuid: ID of the user associated with the payment, if applicable.
  - `object` PaymentRecordObjectRequest
    - `id` string, uuid, required: ID of the invoice
    - `type` 'receivable' | 'payable', required
  - `paid_at` string, date-time: Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
  - `payment_intent_id` string, uuid: Identifier for an payment intent.
  - `payment_intent_status` string: Raw status string of the external payment intent.
  - `payment_method` string: Payment method used or planned for the transaction.
  - `planned_payment_date` string, date: Scheduled date for future payments, required when the payment is planned but not yet executed.

## Response `200`

Successful Response

- PaymentRecordResponse
  - `id` string, uuid, required
  - `amount` integer, required: Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).
  - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW', required
  - `entity_user_id` string, uuid: ID of the user associated with the payment, if applicable.
  - `history` PaymentRecordHistoryResponse[], required: History of the payment record.
    - `entity_user_id` string, uuid
    - `status` 'created' | 'processing' | 'succeeded' | 'canceled', required
    - `timestamp` string, date-time, required: Timestamp of the change in a history
  - `is_external` boolean, required
  - `object` PaymentRecordObjectResponse, required
    - `id` string, uuid, required: ID of the invoice
    - `new_status` string, required: Status, in which object has been moved
    - `old_status` string, required: Status, in which object was before payment
    - `type` 'receivable' | 'payable', required
  - `overpaid_amount` integer: Filled in a case, if payment amount is more, than total_amount
  - `paid_at` string, date-time: Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
  - `payment_intent_id` string, uuid: Identifier for an payment intent.
  - `payment_intent_status` string: Raw status string of the external payment intent.
  - `payment_method` string: Payment method used or planned for the transaction.
  - `planned_payment_date` string, date: Scheduled date for future payments, required when the payment is planned but not yet executed.
  - `status` string: The current status of the payment record. Possible values: `created`, `processing`, `succeeded`, `canceled`.

## Other responses

- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/monite/apis/monite-3.md) - [All operations](https://skmtc.dev/monite/apis/monite-3/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-3/revisions/c13be6f83ce9?raw)