Response 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	Note
`x_account_id` Required.	unicode string	Z9s7Yt0Txsqbbx	Echo request's `x_account_id`
`x_amount` Required.	decimal	89.99	Echo request's `x_amount`
`x_currency` Required.	iso-4217	USD	Echo request's `x_currency`
`x_gateway_reference` Required.	unicode string	a32-74a4-a6a7-3e7	Unique reference for each response issued by the payment processor.
`x_reference` Required.	ascii string	19783	Echo request's `x_reference`
`x_result` Required.	fixed choice	completed	Valid values are `completed`, `failed`, or `pending`.
`x_signature` Required.	hex string, case-insensitive	49d3166063b4d881b50a f0b4648c1244bfa9890a53 ed6bce6d2386404b610777	See Signing mechanism.
`x_test` Required.	true/false	true	Echo request's `x_test`
`x_timestamp` Required.	iso-8601 in UTC	2014-03-24T12:15:41Z	Time of transaction completion. UTC Time: YYYY-MM-DDTHH:MM:SSZ
`x_message`	ascii string	Billing address could not be verified.	A custom error message displayed to the customer.
`x_transaction_type`	fixed choice	authorization	If you're using order management, then the valid values are authorization, capture, void, and refund.
`x_transaction_type`	fixed choice	sale	If you aren't using order management, then this field will use the default value sale.

Was this page helpful?