Update Charge Metadata

patch

https://testapi.payarc.net/v1/charges/{charge_id}

This API allows for the Charge metadata to be edited.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

charge_id

string

required

charge_id here represents the specific charge whose metadata should be updated.

Body Params

metadata

string

A JSON object of key/value pairs to store against the charge, e.g. {"order_number":"PO-12345"}. Provided keys are added or overwritten; existing keys not included in the payload are left unchanged. Sending a key with an empty string value ("") deletes that key. Keys must be non-empty and at most 20 characters; values must be strings of at most 1000 characters. A maximum of 50 keys can be sent per request.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

404404

422422