Do not expose Payment metadata in Shop API

Is your feature request related to a problem? Please describe. The Payment GraphQL type includes the metadata field in both the Admin and Shop APIs. This metadata field can be used (depending on the specifics on the PaymentMethodHandler) to store potentially sensitive data returned by the payment provider. This should not be accessible publicly over the Shop API, even to the owner of that payment.

Describe the solution you’d like Only include it in the Admin API.

[chladog]

For some payment providers exatly those metadata are needed for handling the payment on client-side (e.g. URL to gateway, lang, available methods of payment… that we got from server-provider communication but want to pass along to user).

Describe the solution you’d like change metadata object to hold properties private (accessible only over AdminAPI) and public JSONs so resulting object looks like

Payment {
   metadata {
      public { ... }
      private { ... }
   }
}

Then developer can decide where each subset of metadata belongs to and the terminology makes clear statement on accessibility.

[michaelbromley]

@chladog thank you for the clear explanation.

For reference, here are some more examples of similar flows where data from the provider is required in the storefront:

• Razorpay:
• Adyen Pay by Link API