-
- Abort payment on terminal
- Capture payment
- Filter payments
- Find payment
- Initiate payment flow
- List payment activities
- List payments
- List payments by contact
- List payments by terminal
- Refund payment
- Request payment
- Resume payment on terminal
- Retrieve refund performance
- Retrieve sales performance
- Reverse payment
- Start payment on terminal
- Void payment
Add an item to a metadata set.
A metadata set is an array of unique values. This endpoint ensures that the metadata at the given path is treated as a set: - If the path is empty or does not exist, it is initialized as an empty array. - If the value already exists in the set, it is not added again. - The metadata at the path must be an array (or empty).
Example
If current metadata is {"tags": ["a"]}, adding "b" to path "tags" results in {"tags": ["a", "b"]}.
Adding "a" again results in no change.
key
string
Required. The unique key for the metadata.
path
string
Optional. Optional dot-separated path within the metadata object.
value
any
Required. The value to add to the set.
version
number
Optional. The version number for optimistic locking.
ttl
number
Optional. The time to live in seconds. Affects the whole metadata object, not just the value at path.
UNHANDLED_ERROR
This error occurs when the server encounters an unexpected internal error that it cannot handle gracefully. This typically happens due to bugs, infrastructure issues, or edge cases that weren't anticipated during development.
INVALID_ARGUMENTS
This error occurs when the request contains invalid or missing parameters. Common cases include missing required fields, or values that don't match the expected format or type.
BAD_VERSION
This error occurs when making requests to an API version that does not exist. This commonly happens when using an outdated SDK or when the API version specified in the request URL is incorrect.