Skip to main content
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to ShopifyPaymentsAccount

ShopifyPaymentsAccount

object

Requires the read_shopify_payments or the read_shopify_payments_accounts access scope.

Balance and payout information for a 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.

Anchor to Fields and connectionsFields and connections

•

The name of the account opener.

•
Boolean!non-null

Whether the Shopify Payments setup is completed.

•
[MoneyV2!]!non-null

Current balances in all currencies for the account.

•

A list of balance transactions associated with the shop.

•

All bank accounts configured for the Shopify Payments account.

Anchor to chargeStatementDescriptorschargeStatementDescriptors
•

The statement descriptors used for charges.

These descriptors appear on a customer's credit card or bank statement when they make a purchase.

•
String!non-null

The Shopify Payments account country.

•

The default payout currency for the Shopify Payments account.

•

All disputes that originated from a transaction made with the Shopify Payments account.

•
ID!non-null

A globally-unique ID.

•
Boolean!non-null

Whether the Shopify Payments account can be onboarded.

•

All current and previous payouts made between the account and the bank account.

•

The payout schedule for the account.

Anchor to payoutStatementDescriptorpayoutStatementDescriptor
•

The descriptor used for payouts.

The descriptor appears on a merchant's bank statement when they receive a payout.

Anchor to chargeStatementDescriptorchargeStatementDescriptor
•
StringDeprecated

The statement descriptor used for charges.

The statement descriptor appears on a customer's credit card or bank statement when they make a purchase. Use chargeStatementDescriptors instead.


Was this section helpful?

•
query

Shopify Payments account information, including balances and payouts.


Was this section helpful?

•
interface

Was this section helpful?