ShopifyPaymentsAccount - admin-graphql - OBJECT

Version: 2024-10

Description:

Balance and payout information for a [Shopify Payments](https://help.shopify.com/manual/payments/shopify-payments/getting-paid-with-shopify-payments) account. Balance includes all balances for the currencies supported by the shop. You can also query for a list of payouts, where each payout includes the corresponding currencyCode field.

Access Scopes

the `read_shopify_payments` or the `read_shopify_payments_accounts` access scope.

Fields

• activated: Boolean! - Whether the Shopify Payments setup is completed.
• balance: MoneyV2! - Current balances in all currencies for the account.
• chargeStatementDescriptor: String - The statement descriptor used for charges. The statement descriptor appears on a customer's credit card or bank statement when they make a purchase.
• chargeStatementDescriptors: ShopifyPaymentsChargeStatementDescriptor - The statement descriptors used for charges. These descriptors appear on a customer's credit card or bank statement when they make a purchase.
• country: String! - The Shopify Payments account country.
• defaultCurrency: CurrencyCode! - The default payout currency for the Shopify Payments account.
• id: ID! - A globally-unique ID.
• onboardable: Boolean! - Whether the Shopify Payments account can be onboarded.
• payoutSchedule: ShopifyPaymentsPayoutSchedule! - The payout schedule for the account.
• payoutStatementDescriptor: String - The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout.

Connections

• balanceTransactions: ShopifyPaymentsBalanceTransactionConnection!
• bankAccounts: ShopifyPaymentsBankAccountConnection!
• disputes: ShopifyPaymentsDisputeConnection!
• payouts: ShopifyPaymentsPayoutConnection!

Related queries

• shopifyPaymentsAccount Shopify Payments account information, including balances and payouts.

Related mutations

Related Unions

Examples

• Return a list of all balance transactions

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { shopifyPaymentsAccount { balanceTransactions(first: 10) { nodes { id type test associatedPayout { id status } amount { amount currencyCode } fee { amount } net { amount } sourceId sourceType sourceOrderTransactionId associatedOrder { id } adjustmentsOrders { orderTransactionId amount { amount } name } adjustmentReason } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    shopifyPaymentsAccount {\n      balanceTransactions(first: 10) {\n        nodes {\n          id\n          type\n          test\n          associatedPayout {\n            id\n            status\n          }\n          amount {\n            amount\n            currencyCode\n          }\n          fee {\n            amount\n          }\n          net {\n            amount\n          }\n          sourceId\n          sourceType\n          sourceOrderTransactionId\n          associatedOrder {\n            id\n          }\n          adjustmentsOrders {\n            orderTransactionId\n            amount {\n              amount\n            }\n            name\n          }\n          adjustmentReason\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    shopifyPaymentsAccount {\n      balanceTransactions(first: 10) {\n        nodes {\n          id\n          type\n          test\n          associatedPayout {\n            id\n            status\n          }\n          amount {\n            amount\n            currencyCode\n          }\n          fee {\n            amount\n          }\n          net {\n            amount\n          }\n          sourceId\n          sourceType\n          sourceOrderTransactionId\n          associatedOrder {\n            id\n          }\n          adjustmentsOrders {\n            orderTransactionId\n            amount {\n              amount\n            }\n            name\n          }\n          adjustmentReason\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    shopifyPaymentsAccount {\n      balanceTransactions(first: 10) {\n        nodes {\n          id\n          type\n          test\n          associatedPayout {\n            id\n            status\n          }\n          amount {\n            amount\n            currencyCode\n          }\n          fee {\n            amount\n          }\n          net {\n            amount\n          }\n          sourceId\n          sourceType\n          sourceOrderTransactionId\n          associatedOrder {\n            id\n          }\n          adjustmentsOrders {\n            orderTransactionId\n            amount {\n              amount\n            }\n            name\n          }\n          adjustmentReason\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    shopifyPaymentsAccount {\n      balanceTransactions(first: 10) {\n        nodes {\n          id\n          type\n          test\n          associatedPayout {\n            id\n            status\n          }\n          amount {\n            amount\n            currencyCode\n          }\n          fee {\n            amount\n          }\n          net {\n            amount\n          }\n          sourceId\n          sourceType\n          sourceOrderTransactionId\n          associatedOrder {\n            id\n          }\n          adjustmentsOrders {\n            orderTransactionId\n            amount {\n              amount\n            }\n            name\n          }\n          adjustmentReason\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  shopifyPaymentsAccount {\n    balanceTransactions(first: 10) {\n      nodes {\n        id\n        type\n        test\n        associatedPayout {\n          id\n          status\n        }\n        amount {\n          amount\n          currencyCode\n        }\n        fee {\n          amount\n        }\n        net {\n          amount\n        }\n        sourceId\n        sourceType\n        sourceOrderTransactionId\n        associatedOrder {\n          id\n        }\n        adjustmentsOrders {\n          orderTransactionId\n          amount {\n            amount\n          }\n          name\n        }\n        adjustmentReason\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shopifyPaymentsAccount": {
        "balanceTransactions": {
          "nodes": [
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/44598600",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/512467833",
                "status": "FAILED"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "512467833",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/374523424",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/917000993",
                "status": "FAILED"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "917000993",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/631321250",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/631321250",
                "status": "SCHEDULED"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "631321250",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/725076685",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/725076685",
                "status": "PAID"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "725076685",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/854848137",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
                "status": "PAID"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "623721858",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/867808544",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/867808544",
                "status": "PAID"
              },
              "amount": {
                "amount": "-41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-41.9"
              },
              "sourceId": "867808544",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/714327683",
              "type": "TRANSFER_FAILURE",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
                "status": "FAILED"
              },
              "amount": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "41.9"
              },
              "sourceId": "714327683",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/615671547",
              "type": "TRANSFER_FAILURE",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
                "status": "FAILED"
              },
              "amount": {
                "amount": "11.0",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "1.0"
              },
              "net": {
                "amount": "10.0"
              },
              "sourceId": null,
              "sourceType": null,
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/965204187",
              "type": "TRANSFER",
              "test": false,
              "associatedPayout": {
                "id": "gid://shopify/ShopifyPaymentsPayout/39438702",
                "status": "IN_TRANSIT"
              },
              "amount": {
                "amount": "-43.12",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "-43.12"
              },
              "sourceId": "39438702",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            },
            {
              "id": "gid://shopify/ShopifyPaymentsBalanceTransaction/922259259",
              "type": "TRANSFER_FAILURE",
              "test": false,
              "associatedPayout": {
                "id": null,
                "status": "PENDING"
              },
              "amount": {
                "amount": "43.12",
                "currencyCode": "USD"
              },
              "fee": {
                "amount": "0.0"
              },
              "net": {
                "amount": "43.12"
              },
              "sourceId": "512467833",
              "sourceType": "TRANSFER",
              "sourceOrderTransactionId": null,
              "associatedOrder": null,
              "adjustmentsOrders": [],
              "adjustmentReason": null
            }
          ]
        }
      }
    }
  }

  Return a list of all disputes

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopifyPaymentsListDisputes { shopifyPaymentsAccount { disputes(first: 10) { edges { node { amount { amount currencyCode } evidenceDueBy evidenceSentOn finalizedOn id initiatedAt reasonDetails { reason networkReasonCode } status type } } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopifyPaymentsListDisputes {\n    shopifyPaymentsAccount {\n      disputes(first: 10) {\n        edges {\n          node {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopifyPaymentsListDisputes {\n    shopifyPaymentsAccount {\n      disputes(first: 10) {\n        edges {\n          node {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopifyPaymentsListDisputes {\n    shopifyPaymentsAccount {\n      disputes(first: 10) {\n        edges {\n          node {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopifyPaymentsListDisputes {\n    shopifyPaymentsAccount {\n      disputes(first: 10) {\n        edges {\n          node {\n            amount {\n              amount\n              currencyCode\n            }\n            evidenceDueBy\n            evidenceSentOn\n            finalizedOn\n            id\n            initiatedAt\n            reasonDetails {\n              reason\n              networkReasonCode\n            }\n            status\n            type\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsListDisputes {\n  shopifyPaymentsAccount {\n    disputes(first: 10) {\n      edges {\n        node {\n          amount {\n            amount\n            currencyCode\n          }\n          evidenceDueBy\n          evidenceSentOn\n          finalizedOn\n          id\n          initiatedAt\n          reasonDetails {\n            reason\n            networkReasonCode\n          }\n          status\n          type\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shopifyPaymentsAccount": {
        "disputes": {
          "edges": [
            {
              "node": {
                "amount": {
                  "amount": "100.0",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2013-07-03T19:00:00-04:00",
                "evidenceSentOn": "2013-07-04T07:00:00-04:00",
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/1052608616",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "WON",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/815713555",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "CREDIT_NOT_PROCESSED",
                  "networkReasonCode": "4827"
                },
                "status": "NEEDS_RESPONSE",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2013-07-03T19:00:00-04:00",
                "evidenceSentOn": "2013-07-04T07:00:00-04:00",
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/782360659",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "WON",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": null,
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/670893524",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "NEEDS_RESPONSE",
                "type": "INQUIRY"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/598735659",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "NEEDS_RESPONSE",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "100.0",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/297752803",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "LOST",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/257169523",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "NEEDS_RESPONSE",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": "2024-11-07T19:00:00-05:00",
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/85190714",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "UNDER_REVIEW",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "100.0",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/46484353",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "FRAUDULENT",
                  "networkReasonCode": "4827"
                },
                "status": "LOST",
                "type": "CHARGEBACK"
              }
            },
            {
              "node": {
                "amount": {
                  "amount": "11.5",
                  "currencyCode": "USD"
                },
                "evidenceDueBy": "2024-11-20T19:00:00-05:00",
                "evidenceSentOn": null,
                "finalizedOn": null,
                "id": "gid://shopify/ShopifyPaymentsDispute/35982383",
                "initiatedAt": "2013-05-04T00:00:00Z",
                "reasonDetails": {
                  "reason": "SUBSCRIPTION_CANCELLED",
                  "networkReasonCode": "4827"
                },
                "status": "NEEDS_RESPONSE",
                "type": "CHARGEBACK"
              }
            }
          ]
        }
      }
    }
  }

  Return a list of all payouts

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopifyPaymentsPayoutShow { shopifyPaymentsAccount { payouts(first: 10) { nodes { id issuedAt net { amount currencyCode } status transactionType } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10) {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10) {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10) {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10) {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsPayoutShow {\n  shopifyPaymentsAccount {\n    payouts(first: 10) {\n      nodes {\n        id\n        issuedAt\n        net {\n          amount\n          currencyCode\n        }\n        status\n        transactionType\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shopifyPaymentsAccount": {
        "payouts": {
          "nodes": [
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "PAID",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/631321250",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "SCHEDULED",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/714327683",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "FAILED",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/725076685",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "PAID",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/867808544",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "PAID",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/917000993",
              "issuedAt": "2012-11-13T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "FAILED",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/39438702",
              "issuedAt": "2013-11-01T00:00:00Z",
              "net": {
                "amount": "43.12",
                "currencyCode": "USD"
              },
              "status": "SCHEDULED",
              "transactionType": "DEPOSIT"
            },
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/512467833",
              "issuedAt": "2013-12-01T00:00:00Z",
              "net": {
                "amount": "43.12",
                "currencyCode": "USD"
              },
              "status": "FAILED",
              "transactionType": "DEPOSIT"
            }
          ]
        }
      }
    }
  }

  Return a single payout

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopifyPaymentsPayoutShow { shopifyPaymentsAccount { payouts(first: 10, query: \\\"id:623721858\\\") { nodes { id issuedAt net { amount currencyCode } status transactionType } } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10, query: \"id:623721858\") {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10, query: \"id:623721858\") {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10, query: \"id:623721858\") {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopifyPaymentsPayoutShow {\n    shopifyPaymentsAccount {\n      payouts(first: 10, query: \"id:623721858\") {\n        nodes {\n          id\n          issuedAt\n          net {\n            amount\n            currencyCode\n          }\n          status\n          transactionType\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsPayoutShow {\n  shopifyPaymentsAccount {\n    payouts(first: 10, query: \"id:623721858\") {\n      nodes {\n        id\n        issuedAt\n        net {\n          amount\n          currencyCode\n        }\n        status\n        transactionType\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shopifyPaymentsAccount": {
        "payouts": {
          "nodes": [
            {
              "id": "gid://shopify/ShopifyPaymentsPayout/623721858",
              "issuedAt": "2012-11-12T00:00:00Z",
              "net": {
                "amount": "41.9",
                "currencyCode": "USD"
              },
              "status": "PAID",
              "transactionType": "DEPOSIT"
            }
          ]
        }
      }
    }
  }

  Return the current balance

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query ShopifyPaymentsShowBalance { shopifyPaymentsAccount { balance { amount currencyCode } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query ShopifyPaymentsShowBalance {\n    shopifyPaymentsAccount {\n      balance {\n        amount\n        currencyCode\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query ShopifyPaymentsShowBalance {\n    shopifyPaymentsAccount {\n      balance {\n        amount\n        currencyCode\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query ShopifyPaymentsShowBalance {\n    shopifyPaymentsAccount {\n      balance {\n        amount\n        currencyCode\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query ShopifyPaymentsShowBalance {\n    shopifyPaymentsAccount {\n      balance {\n        amount\n        currencyCode\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query ShopifyPaymentsShowBalance {\n  shopifyPaymentsAccount {\n    balance {\n      amount\n      currencyCode\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "shopifyPaymentsAccount": {
        "balance": [
          {
            "amount": "0.0",
            "currencyCode": "USD"
          }
        ]
      }
    }
  }