API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

ShopifyPaymentsAccount object

Version unstable

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2021-07 (Release candidate)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2021-04 (Latest)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2021-01

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2020-10

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2020-07

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2020-04

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2020-01 (Unsupported)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2019-10 (Unsupported)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2019-07 (Unsupported)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Version 2019-04 (Unsupported)

Restricted access

Requires the read_shopify_payments or read_shopify_payments_accounts approval 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.

Required access

User must have given access.

Connections

  • All bank accounts configured for the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • All disputes related to the Shopify Payments account.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • id
    • initiated_at
    • status

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

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

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    transactionType ( ShopifyPaymentsPayoutTransactionType )

    Filter the direction of the payout.

Fields

Types that return ShopifyPaymentsAccount

Implements

Deprecated fields

  • chargeStatementDescriptor (String) deprecated

    Statement descriptor used for charges.

    This is what buyers will see on their credit card or bank statements when making a purchase.

    Deprecation warning

    Use chargeStatementDescriptors instead

Samples