Payments - Update Metadata

POST /payments/{payment_id}/update_metadata

Update metadata for a payment.

cURL

cURL
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": {}
}'

Responses

  • 200 — Metadata updated successfully

  • 400 — Bad request

Example 200 response:

{
  "payment_id": "<string>",
  "metadata": {}
}

Authorization

  • 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

Content-Type: application/json

  • metadata (object, required) Metadata is useful for storing additional, unstructured information on an object.

Example request body:

Response Fields (200)

  • payment_id (string) — The identifier for the payment

  • metadata (object) — Metadata is useful for storing additional, unstructured information on an object.

Was this page helpful? Yes / No

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/payments/payments--update-metadata.mdx

Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/payments/payments--update-metadata

Related:

  • https://api-reference.hyperswitch.io/v1/payments/payments--complete-authorize

  • https://api-reference.hyperswitch.io/v1/payments/payments--submit-eligibility-data

PreviousProfile - RetrieveNextRouting - Deactivate