Update transaction metadata

Adds or changes your own key-value metadata on one Stripe payment and returns 202 even if the payment has not arrived. Coris stores it for you to read back, and standard rules, alerts and the portal do not use it. For metadata on an account, use Update account metadata.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

The kind of ID in source_transaction_id. Metadata stays on the object you name, so read it back with the same type and ID.

  • stripe_payment_intent: a Stripe PaymentIntent ID.
  • stripe_charge: a Stripe Charge ID.
Allowed:
string
required

The transaction's ID at the source.

Body Params

Metadata key-value pairs

Key-value pairs that you choose, and the API does not check them. A value can be any JSON type, and null removes the key. The metadata does not appear in List account transactions.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
202

Coris accepted the metadata, and the body is empty. If the payment has not arrived, Coris holds the metadata and applies it on arrival. With no match within 3 days, Coris drops it.

A 202 does not confirm the payment. A mistyped ID, an unknown source_transaction_type or a body that is not a JSON object also returns 202, and nothing is stored. Confirm with Get transaction metadata once the payment has arrived.

You cannot list held metadata. To drop a held key, post it again with null: Coris applies held calls in order.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html
application/json