Update a payment intent's amount

Path parameters

payment_intent_idstringRequired
ID of an existing payment intent you want to update.

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.
amountintegerRequired

The new payment amount in minor units.

Response

Successful Response
idstringformat: "uuid"
A unique ID of this payment intent.
updated_atdatetime
UTC date and time when this payment intent was last updated.
amountinteger

The payment amount in minor units.

currencystring

The payment currency, as a three-letter ISO currency code.

payment_methodslist of enums
recipientobject

The payment recipient - either the current entity (in case of accounts receivable invoice payments) or a counterpart (in case of accounts payable bill payments).

statusstring

The status of the payment intent.

application_fee_amountinteger or null
batch_payment_idstring or nullformat: "uuid"
Reserved for internal use.
invoiceobject or null
objectobject or null

If the payment link was created for a payable or receivable invoice stored in Monite (rather than an external invoice or a one-off payment), this object contains the ID of that payable or receivable.

payerobject or null
payment_referencestring or null

The payment reference. If not provided explicitly by the client, Monite uses the invoice number (document_id) as the payment reference.

Note: Monite normalizes payment references for certain types of payments when passing information to the payment processing provider.

providerstring or null
Reserved for internal use.
selected_payment_methodenum or null

The payment method selected by the payer on the payment page, or null if the payment has not been initiated.

Errors