updateMetadata

MUTATION

Updates metadata for an item.

Arguments

idRequired

String

The id of the item you want to update metadata for.

metadata_associateRequired

MetadataAssociate

The type of item you want to update metadata for. Options are: AUTHORIZATION, INVOICE, PAYMENT_METHOD_TOKEN, PAYMENT_SESSION, PAYOR, RECURRING, TRANSACTION, SALE

Values

AUTHORIZATIONINVOICEMERCHANTPAYMENT_INTENTPAYMENT_METHOD_TOKENPAYMENT_SESSIONPAYORRECURRINGTRANSACTIONSALESPLIT

merchant_uidRequired

String

The Pay Theory merchant_uid of the item you want to update metadata for.

metadataRequired

AWSJSON

The metadata you want to update the item with. Any keys passed in will overwrite the existing metadata.

Response

Boolean

Examples

Add metadata to a transaction

Adds metadata to a transaction. Send metadata as a JSON string.

SUCCESS 200

GRAPHQL

mutation UpdateMetadata($id: String!, $metadata_associate: MetadataAssociate!, $merchant_uid: String!, $metadata: AWSJSON!) {
  updateMetadata(id: $id, metadata_associate: $metadata_associate, merchant_uid: $merchant_uid, metadata: $metadata)
}