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?

Mutation Reference

1mutation shopifyPaymentsPayoutAlternateCurrencyCreate($accountId: ID, $currency: CurrencyCode!) {
2  shopifyPaymentsPayoutAlternateCurrencyCreate(accountId: $accountId, currency: $currency) {
3    payout {
4      # ShopifyPaymentsToolingProviderPayout fields
5    }
6    success
7    userErrors {
8      field
9      message
10    }
11  }
12}

Input

1{
2  "accountId": "gid://shopify/<objectName>/10079785100",
3  "currency": "AED"
4}

{
  "accountId": "gid://shopify/<objectName>/10079785100",
  "currency": "AED"
}