shopPayPaymentRequestSessionBusinessEntityUpdate

mutation

Updates the business entity associated with an ongoing Shop Pay payment request session. You can change the business entity before submitting payment, or after the latest payment attempt has failed.

Anchor to Arguments

Arguments

Anchor to businessEntityIdbusinessEntityId •String! required: The full global ID of the business entity to process this payment through, such as gid://shopify/BusinessEntity/123, returned by the Admin API businessEntities query. To use the shop's primary business entity, provide its global ID.
Anchor to tokentoken •String! required: A payment request session token.

Was this section helpful?

Anchor to ShopPayPaymentRequestSessionBusinessEntityUpdatePayload returnsShopPayPaymentRequestSessionBusinessEntityUpdatePayload returns

Anchor to shopPayPaymentRequestSessionshopPayPaymentRequestSession •ShopPayPaymentRequestSession: The Shop Pay payment request session.

Show fields
Anchor to userErrorsuserErrors •[UserErrorsShopPayPaymentRequestSessionUserErrors!]! non-null: Error codes for failed Shop Pay payment request session mutations.

Show fields

Was this section helpful?

Examples

shopPayPaymentRequestSessionBusinessEntityUpdate reference

Mutation Reference

mutation shopPayPaymentRequestSessionBusinessEntityUpdate($businessEntityId: String!, $token: String!) {

shopPayPaymentRequestSessionBusinessEntityUpdate(businessEntityId: $businessEntityId, token: $token) {

shopPayPaymentRequestSession {

# ShopPayPaymentRequestSession fields

}

userErrors {

field

message

}

Input

{

"businessEntityId": "<your-businessEntityId>",

"token": "<your-token>"

}