getPaymentSDK query

The getPaymentSDK query gets the payment PayPal SDK URLs and other related values.

Syntax

Copy
{
    getPaymentSDK(
      location: PaymentLocation!
    )GetPaymentSDKOutput
}
Copied to your clipboard
{
    getPaymentSDK(
      location: PaymentLocation!
    )GetPaymentSDKOutput
}

Reference

The getPaymentSDK reference provides detailed information about the types and fields defined in this query.

Example usage

The following example runs the getPaymentSDK query.

Request:

Copy
query {
  getPaymentSDK(location: CHECKOUT) {
    sdkParams {
      code
      params {
        name
        value
      }
    }
  }
}
Copied to your clipboard
query {
  getPaymentSDK(location: CHECKOUT) {
    sdkParams {
      code
      params {
        name
        value
      }
    }
  }
}

Response:

Copy
{
    "data": {
        "getPaymentSDK": {
            "sdkParams": [
                {
                    "code": "payment_services_paypal_smart_buttons",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_apple_pay",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_google_pay",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_hosted_fields",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        },
                        {
                            "name": "data-partner-attribution-id",
                            "value": "MagentoPayments_SP_PCP_Int"
                        },
                        {
                            "name": "data-client-token",
                            "value": "eyJicmFpbnRyZWUiOnsiYXV0aG9yaXphdGlvbkZpbmdlcnByaW50IjoiMTFiZmFjZGM5YWEyM2ZhZjdmNTQwMzc0NGZmYzEwMjI4YjFjODBmZjg4NDdlYjcyMjMyMmM1OTE0MTU3OWYzZHxtZXJjaGFudF9pZD1yd3dua3FnMnhnNTZobTJuJnB1YmxpY19rZXk9NjNrdm4zN3Z0MjlxYjRkZiZjcmVhdGVkX2F0PTIwMjQtMDItMTNUMTU6Mjc6NTkuNDg5WiIsInZlcnNpb24iOiIzLXBheXBhbCJ9LCJwYXlwYWwiOnsiaWRUb2tlbiI6bnVsbCwiYWNjZXNzVG9rZW4iOiJBMjFBQUlEc1hFbHFlVzh6d1FTTGZsVFdkMHR1UkhIYlBYVTdfYTQzNVFxUVQ5MTRmUjhzclN1RTQzdlg4TnVXV0N1NHZIeUVoVG1BUnhVekdnU3R3VDJCNVFtczBrVjRnIn19"
                        },
                        {
                            "name": "data-expires-in",
                            "value": "3600"
                        }
                    ]
                }
            ]
        }
    }
}
Copied to your clipboard
{
    "data": {
        "getPaymentSDK": {
            "sdkParams": [
                {
                    "code": "payment_services_paypal_smart_buttons",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_apple_pay",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_google_pay",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        }
                    ]
                },
                {
                    "code": "payment_services_paypal_hosted_fields",
                    "params": [
                        {
                            "name": "src",
                            "value": "https:\/\/www.paypal.com\/sdk\/js?client-id=..."
                        },
                        {
                            "name": "data-partner-attribution-id",
                            "value": "MagentoPayments_SP_PCP_Int"
                        },
                        {
                            "name": "data-client-token",
                            "value": "eyJicmFpbnRyZWUiOnsiYXV0aG9yaXphdGlvbkZpbmdlcnByaW50IjoiMTFiZmFjZGM5YWEyM2ZhZjdmNTQwMzc0NGZmYzEwMjI4YjFjODBmZjg4NDdlYjcyMjMyMmM1OTE0MTU3OWYzZHxtZXJjaGFudF9pZD1yd3dua3FnMnhnNTZobTJuJnB1YmxpY19rZXk9NjNrdm4zN3Z0MjlxYjRkZiZjcmVhdGVkX2F0PTIwMjQtMDItMTNUMTU6Mjc6NTkuNDg5WiIsInZlcnNpb24iOiIzLXBheXBhbCJ9LCJwYXlwYWwiOnsiaWRUb2tlbiI6bnVsbCwiYWNjZXNzVG9rZW4iOiJBMjFBQUlEc1hFbHFlVzh6d1FTTGZsVFdkMHR1UkhIYlBYVTdfYTQzNVFxUVQ5MTRmUjhzclN1RTQzdlg4TnVXV0N1NHZIeUVoVG1BUnhVekdnU3R3VDJCNVFtczBrVjRnIn19"
                        },
                        {
                            "name": "data-expires-in",
                            "value": "3600"
                        }
                    ]
                }
            ]
        }
    }
}

Input attributes

The getPaymentSDK query must contain the following attribute:

Output attributes

The GetPaymentSDKOutput object must contain the following attributes:

SDKParams object

The SDKParams object provides details about the SDK parameters:

Last updated 4/5/2025

Was this helpful?

Yes

No