ShopifyPaymentsBankAccount

Version 2019-04

A bank account that can receive payouts.

Required access

read_shopify_payments_bank_accounts access scope

Show definition
"""
A bank account that can receive payouts.
"""
type ShopifyPaymentsBankAccount implements Node {
  """
  The account number of the bank account.
  """
  accountNumber: String!
  """
  The last digits of the account number (the rest is redacted).
  """
  accountNumberLastDigits: String!
  """
  The name of the bank.
  """
  bankName: String
  """
  The country of the bank.
  """
  country: CountryCode!
  """
  The currency of the bank account.
  """
  currency: CurrencyCode!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  All current and previous payouts made between the account and the bank account.
  """
  payouts(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Filter the direction of the payout.
    """
    transactionType: ShopifyPaymentsPayoutTransactionType
  ): ShopifyPaymentsPayoutConnection!
  """
  The routing number of the bank account.
  """
  routingNumber: String!
  """
  The status of the bank account.
  """
  status: ShopifyPaymentsBankAccountStatus!
}

Implements

Connections

payouts (ShopifyPaymentsPayoutConnection!)

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

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: true

transactionType ( ShopifyPaymentsPayoutTransactionType )

Filter the direction of the payout.

Fields

accountNumber (String!)

The account number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

accountNumberLastDigits (String!)

The last digits of the account number (the rest is redacted).

bankName (String)

The name of the bank.

country (CountryCode!)

The country of the bank.

currency (CurrencyCode!)

The currency of the bank account.

id (ID!)

Globally unique identifier.

routingNumber (String!)

The routing number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

status (ShopifyPaymentsBankAccountStatus!)

The status of the bank account.

Version 2019-07 (Latest)

A bank account that can receive payouts.

Required access

read_shopify_payments_bank_accounts access scope

Show definition
"""
A bank account that can receive payouts.
"""
type ShopifyPaymentsBankAccount implements Node {
  """
  The account number of the bank account.
  """
  accountNumber: String!
  """
  The last digits of the account number (the rest is redacted).
  """
  accountNumberLastDigits: String!
  """
  The name of the bank.
  """
  bankName: String
  """
  The country of the bank.
  """
  country: CountryCode!
  """
  The date that the bank account was created.
  """
  createdAt: DateTime!
  """
  The currency of the bank account.
  """
  currency: CurrencyCode!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  All current and previous payouts made between the account and the bank account.
  """
  payouts(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Filter the direction of the payout.
    """
    transactionType: ShopifyPaymentsPayoutTransactionType
  ): ShopifyPaymentsPayoutConnection!
  """
  The routing number of the bank account.
  """
  routingNumber: String!
  """
  The status of the bank account.
  """
  status: ShopifyPaymentsBankAccountStatus!
}

Implements

Connections

payouts (ShopifyPaymentsPayoutConnection!)

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

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: true

transactionType ( ShopifyPaymentsPayoutTransactionType )

Filter the direction of the payout.

Fields

accountNumber (String!)

The account number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

accountNumberLastDigits (String!)

The last digits of the account number (the rest is redacted).

bankName (String)

The name of the bank.

country (CountryCode!)

The country of the bank.

createdAt (DateTime!)

The date that the bank account was created.

currency (CurrencyCode!)

The currency of the bank account.

id (ID!)

Globally unique identifier.

routingNumber (String!)

The routing number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

status (ShopifyPaymentsBankAccountStatus!)

The status of the bank account.

Version 2019-10 (Release candidate)

A bank account that can receive payouts.

Required access

read_shopify_payments_bank_accounts access scope

Show definition
"""
A bank account that can receive payouts.
"""
type ShopifyPaymentsBankAccount implements Node {
  """
  The account number of the bank account.
  """
  accountNumber: String!
  """
  The last digits of the account number (the rest is redacted).
  """
  accountNumberLastDigits: String!
  """
  The name of the bank.
  """
  bankName: String
  """
  The country of the bank.
  """
  country: CountryCode!
  """
  The date that the bank account was created.
  """
  createdAt: DateTime!
  """
  The currency of the bank account.
  """
  currency: CurrencyCode!
  """
  Globally unique identifier.
  """
  id: ID!
  """
  All current and previous payouts made between the account and the bank account.
  """
  payouts(
    """
    Returns the elements that come after the specified cursor.
    """
    after: String
    """
    Returns the elements that come before the specified cursor.
    """
    before: String
    """
    Returns up to the first `n` elements from the list.
    """
    first: Int
    """
    Returns up to the last `n` elements from the list.
    """
    last: Int
    """
    Reverse the order of the underlying list.
    """
    reverse: Boolean = false
    """
    Filter the direction of the payout.
    """
    transactionType: ShopifyPaymentsPayoutTransactionType
  ): ShopifyPaymentsPayoutConnection!
  """
  The routing number of the bank account.
  """
  routingNumber: String!
  """
  The status of the bank account.
  """
  status: ShopifyPaymentsBankAccountStatus!
}

Implements

Connections

payouts (ShopifyPaymentsPayoutConnection!)

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

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: true

transactionType ( ShopifyPaymentsPayoutTransactionType )

Filter the direction of the payout.

Fields

accountNumber (String!)

The account number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

accountNumberLastDigits (String!)

The last digits of the account number (the rest is redacted).

bankName (String)

The name of the bank.

country (CountryCode!)

The country of the bank.

createdAt (DateTime!)

The date that the bank account was created.

currency (CurrencyCode!)

The currency of the bank account.

id (ID!)

Globally unique identifier.

routingNumber (String!)

The routing number of the bank account.

Required access

read_shopify_payments_bank_accounts_sensitive access scope

status (ShopifyPaymentsBankAccountStatus!)

The status of the bank account.

Sign up for a Partner account to get started.

Sign up