Sign in
Payins

Update payin metadata

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

Updating metadata will merge with the existing metadata stored on the chargeback by the top-level key. If the same top-level key is passed in this request, it will overwrite the value stored on the chargeback. 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.

Payin metadata must be less than 8 KB in size.

Payin metadata can only be updated using an API key. This request should not be made by your frontend and should only be done by backend logic that only the platform can complete.

patch/v1/payins/{payin_id}/metadata

Parameters

#/paths/~1v1~1payins/get/parameters/0 — unresolved $ref
#/paths/~1v1~1payins~1%7Bpayin_id%7D/get/parameters/1 — unresolved $ref

Request body

object required

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.

Example request

{
  "key1": "value1",
  "key2": {
    "inner_key1": "inner_value1"
  }
}

Response

OK

statusStatus — unresolved $ref
dataData — unresolved $ref
errorsErrors — unresolved $ref

Changes

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