shopifyPaymentsPayoutAlternateCurrencyCreate

Creates an alternate currency payout for a Shopify Payments account.

Use it in a workflow

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

mutation ShopifyPaymentsPayoutAlternateCurrencyCreate($accountId: ID, $currency: CurrencyCode!) {
  shopifyPaymentsPayoutAlternateCurrencyCreate(
    accountId: $accountId
    currency: $currency
  ) {
    payout {
      amount {
        amount
        currencyCode
      }
      arrivalDate
      createdAt
      currency
      remoteId
    }
    success
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

{
  "currency": "USD",
  "accountId": "string"
}

Response

Read the result with {{shopifypaymentspayoutalternatecurrencycreate.response.data.data.shopifyPaymentsPayoutAlternateCurrencyCreate}}. If the API returns errors, the step fails and they are at {{shopifypaymentspayoutalternatecurrencycreate.response.data.errors}}.

Need more? See the Shopify guide for connection setup and behaviour shared by every action.