Update a payment record

PATCH

/payment_records/:payment_record_id

PATCH

/v1/payment_records/:payment_record_id

curl -X PATCH https://api.sandbox.monite.com/v1/payment_records/payment_record_id \
     -H "x-monite-version: 2024-05-25" \
     -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "id",
  "amount": 1,
  "currency": "AED",
  "history": [
    {
      "status": "created",
      "timestamp": "2024-01-15T09:30:00Z",
      "entity_user_id": "entity_user_id"
    }
  ],
  "is_external": true,
  "object": {
    "id": "id",
    "new_status": "new_status",
    "old_status": "old_status",
    "type": "receivable"
  },
  "entity_user_id": "entity_user_id",
  "overpaid_amount": 1,
  "paid_at": "2024-01-15T09:30:00Z",
  "payment_intent_id": "payment_intent_id",
  "payment_intent_status": "payment_intent_status",
  "payment_method": "payment_method",
  "planned_payment_date": "planned_payment_date",
  "status": "status"
}

Authentication

AuthorizationBearer

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

Path parameters

payment_record_idstringRequired

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

entity_user_idstringOptionalformat: "uuid"

ID of the user associated with the payment, if applicable.

overpaid_amountintegerOptional>=0Defaults to 0

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

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.

statusstringOptionalDefaults to succeeded

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

Errors

401

Patch Payment Records ID Request Unauthorized Error

422

Patch Payment Records ID Request Unprocessable Entity Error

429

Patch Payment Records ID Request Too Many Requests Error

Authentication

Path parameters

Headers

Request

Response

Errors