Payments

Update a payment's metadata

Replaces the payment's metadata. Amount, status and every other field stay as the provider reported them.

patch/api/v1/payments/{id}

Request

idstring required

The resource identifier returned by the merchant API.

metadataobject required

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

Successful response

idstring required

object'payment' required

livemodeboolean required

createdAtstring date-time required

status'pending' | 'succeeded' | 'failed' | 'cancelled' required

amountMinorinteger required

amountRefundedMinorinteger required

refundedboolean required

currencystring required

customerIdstring nullable

subscriptionIdstring nullable

checkoutSessionIdstring nullable

paymentLinkIdstring nullable

receiptNumberstring nullable

receiptUrlstring nullable

referencestring nullable

metadataobject required

Up to 50 key-value pairs; keys up to 40 characters, values strings up to 500 characters.

disputedboolean required

No recorded changes to this operation across all 1 revision of this API.