Request values

Deprecated

Starting April 30, 2022, new users can no longer install your legacy Hosted Payment SDK (HPSDK) integrations. Your new payments app should be launched by this time to ensure that there's no disruption with new user onboarding. Existing users will have until July 31, 2022 to switch to your payments app. In early May 2022, Shopify will contact impacted users who haven't migrated to the new platform to help them adopt an alternative payments app and avoid payment processing disruptions. After July 31, 2022, all HPSDK integrations will be deprecated.

Note

To learn more about the HPSDK deprecation, and how to migrate to Payments Platform, refer to Hosted Payment SDK overview.

Note

Learn more about the new payments platform.

Key	Type	Example
`x_account_id` Required. Note: This is an account identifier assigned to the merchant by the payment processor.	unicode string	Z9s7Yt0Txsqbbx
`x_amount` Required.	decimal	89.99
`x_currency` Required.	iso-4217	USD
`x_gateway_reference` Required. Note: The reference of the payment that's returned by the gateway when the first transaction is created. This will only be present in order management requests.	unicode string	a32-74a4-a6a7-3e7
`x_reference` Required. Note: Unique reference of an order assigned by the merchant.	ascii string	19783
`x_shop_country` Required.	iso-3166-1alpha-2	US
`x_shop_name` Required.	unicode string	Widgets Inc
`x_signature` Required. Note: See Signing mechanism.	hex string, case-insensitive	3a59e201a9b8692702b8c41dcba476d4a46e5f5c
`x_test` Required. Note: Indicates whether or not this request should be processed in test mode (if supported).	true/false	true
`x_url_callback` Required. Note: URL to which a callback notification should be sent asynchronously.	url	https://myshopify.io/ping/1
`x_url_cancel` Required. Note: URL to which customer must be redirected when they wish to quit payment flow and return to the merchant's site.	url	https://myshopify.io
`x_url_complete` Required. Note: URL to which customer must be redirected upon successfully completing payment flow.	url	https://myshopify.io/orders/1/done
`x_transaction_type` Note: You'll only get this value if you're using order management. The valid values are `capture`, `refund`, `void`.	fixed choice	capture
`x_customer_billing_address1`	unicode string	241 Spadina Ave
`x_customer_billing_address2`	unicode string
`x_customer_billing_city`	unicode string	Toronto
`x_customer_billing_company`	unicode string	Shopify
`x_customer_billing_country`	iso-3166-1 alpha-2	CA
`x_customer_billing_phone`	unicode string	+1-613-987-6543
`x_customer_billing_state`	unicode string	ON
`x_customer_billing_zip`	unicode string	M5T 3A8
`x_customer_email`	unicode string	boris.slobodin@example.com
`x_customer_first_name`	unicode string	Boris
`x_customer_last_name`	unicode string	Slobodin
`x_customer_phone`	unicode string	+1-613-987-6543
`x_customer_shipping_address1`	unicode string	241 Spadina Ave
`x_customer_shipping_address2`	unicode string
`x_customer_shipping_city`	unicode string	Toronto
`x_customer_shipping_company`	unicode string	Shopify
`x_customer_shipping_country`	iso-3166-1 alpha-2	CA
`x_customer_shipping_first_name`	unicode string	Boris
`x_customer_shipping_last_name`	unicode string	Slobodin
`x_customer_shipping_phone`	unicode string	+1-416-123-4567
`x_customer_shipping_state`	unicode string	ON
`x_customer_shipping_zip`	unicode string	M5T 3A8
`x_description`	unicode string	Order #123
`x_invoice`	unicode string	#123
`x_shopify_order_id` Note: The unique identifier of the order the request originated from. This will only be present in order management requests.	integer	450789469

Was this page helpful?