Solved

Value of externalHandle on the paymentsAppConfigure API

MyriamK
Shopify Partner
1 0 0

As part of the GraphQL "paymentsAppConfigure", we need to add the "externalHandle" value. What exactly should this value be set to? We have tried the public API key which did not work. Should it be populated with the merchant identifier used on the Payment Gateway side?

 

Noting that our payment app has been approved and published, and we created a new dev store and trying to install it there.

 

Thank you

Accepted Solution (1)

Alan
Shopify Staff
129 15 24

This is an accepted solution.

Hey @MyriamK - I've noticed that some developers have tried using their Public API as the value for this field, and have had it work before. That said, I would recommend against this as it could potentially allow your API key to surface in parts of your app that you may not want it to. This could cause security/authorization issues. 

It is odd that it didn't work for you though, as technically most things should work there as long as they contain accepted values (alphanumeric characters). Some developers just supply their app's name (or the merchant identifier you mentioned) in the externalHandle field as well - have you tried this? If that doesn't work please let us know and we can keep looking into this with you. 

 

Cheers!

Alan | API Support @ Shopify
- Was my reply helpful? Click Like to let me know!
- Was your question answered? Mark it as an Accepted Solution
- To learn more visit Shopify.dev or the Shopify Web Design and Development Blog

View solution in original post

Reply 1 (1)

Alan
Shopify Staff
129 15 24

This is an accepted solution.

Hey @MyriamK - I've noticed that some developers have tried using their Public API as the value for this field, and have had it work before. That said, I would recommend against this as it could potentially allow your API key to surface in parts of your app that you may not want it to. This could cause security/authorization issues. 

It is odd that it didn't work for you though, as technically most things should work there as long as they contain accepted values (alphanumeric characters). Some developers just supply their app's name (or the merchant identifier you mentioned) in the externalHandle field as well - have you tried this? If that doesn't work please let us know and we can keep looking into this with you. 

 

Cheers!

Alan | API Support @ Shopify
- Was my reply helpful? Click Like to let me know!
- Was your question answered? Mark it as an Accepted Solution
- To learn more visit Shopify.dev or the Shopify Web Design and Development Blog