Skip to main content
POST
/
payments
/
{payment_id}
/
update_metadata
Payments - Update Metadata
curl --request POST \
  --url https://sandbox.hyperswitch.io/payments/{payment_id}/update_metadata \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "metadata": {}
}'
{
  "payment_id": "<string>",
  "metadata": {}
}

Authorizations

api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Path Parameters

payment_id
string
required

The identifier for payment

Body

application/json
metadata
object
required

Metadata is useful for storing additional, unstructured information on an object.

Response

Metadata updated successfully

payment_id
string
required

The identifier for the payment

metadata
object | null

Metadata is useful for storing additional, unstructured information on an object.