Skip to main content

Choose a version:

shopifyPaymentsPayoutAlternateCurrencyCreate

mutation

Requires write_shopify_payments_tooling access scope.

Creates an alternate currency payout for a Shopify Payments account.

Arguments

Anchor to accountIdaccountId •ID: The ID of the Shopify Payments account on which the mutation is being performed.
Anchor to currencycurrency •CurrencyCode! required: The currency of the balance to payout.

Was this section helpful?

Anchor to ShopifyPaymentsPayoutAlternateCurrencyCreatePayload returnsShopifyPaymentsPayoutAlternateCurrencyCreatePayload returns

Anchor to payoutpayout •ShopifyPaymentsToolingProviderPayout: The resulting alternate currency payout created.
Anchor to successsuccess •Boolean: Whether the alternate currency payout was created successfully.
Anchor to userErrorsuserErrors •[ShopifyPaymentsPayoutAlternateCurrencyCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?