Update payment method metadata

The body of the request is the JSON key-value metadata to patch to the payment method. Do not use the metadata field to store sensitive or confidential data.

Updating metadata will merge with the existing metadata stored on the payment method by the top-level key. If the same top-level key is passed in this request, it will overwrite the value stored on the payment method. Only keys included in the payload will be updated. To remove a key, set the key's value to null. To remove all metadata pass null for the metadata value.

Updates to the payment method's metadata are reflected on the associated payments in the method_metadata field.

Payment method metadata must be less than 8 KB in size.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique payment method identifier.

Prefix is "mtd" in production and "sbx_mtd" in sandbox.

Body Params

Valid JSON key-value object specified by the platform to store additional information. Keys are queryable in list endpoints. Do not use the metadata field to store sensitive or confidential data.

Metadata must be less than 8 KB in size.

Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Language
Credentials
Bearer
APIKey
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json