Skip to main content
Version: Lab (preview)

Metadata

Metadata is used to pass customer data to track items in Pay Theory Systems.

These calls allow you to update or delete metadata for an item you created with metadata.


MetadataAssociate​

These are the types of items you can associate metadata with.

  • AUTHORIZATION
  • INVOICE
  • MERCHANT
  • PAYMENT_METHOD_TOKEN
  • PAYOR
  • RECURRING
  • TRANSACTION
  • SALE
  • SPLIT

Update Metadata​

mutation {
updateMetadata(id: String, merchant_uid: String, metadata: JSON, metadata_associate: MetadataAssociate)
}

Parameters

Keytypedescription
idStringThe id of the item you want to update metadata for.
merchant_uidStringThe Pay Theory merchant_uid of the item you want to update metadata for.
metadataJSONThe metadata you want to update the item with. Any keys passed in will overwrite the existing metadata.
metadata_associateMetadataAssociateThe type of item you want to update metadata for. Options are: AUTHORIZATION, INVOICE, PAYMENT_METHOD_TOKEN, PAYMENT_SESSION, PAYOR, RECURRING, TRANSACTION, SALE

Returns

Returns true if it was successful or an error if it was not.


Delete Metadata​

mutation {
deleteMetadata(id: String, merchant_uid: String, metadata_associate: MetadataAssociate, metadata_keys: [String]!)
}

Parameters

Keytypedescription
idStringThe id of the item you want to delete metadata for.
merchant_uidStringThe Pay Theory merchant_uid of the item you want to delete metadata for.
metadata_associateMetadataAssociateThe type of item you want to delete metadata for. Options are: AUTHORIZATION, INVOICE, PAYMENT_METHOD_TOKEN, PAYMENT_SESSION, PAYOR, RECURRING, TRANSACTION, SALE
metadata_keys[String]!The keys of the metadata you want to delete.

Returns

Returns true if it was successful or an error if it was not.