Skip to main content
Anchor to ShopifyPaymentsBankAccount

ShopifyPaymentsBankAccount

object

Requires read_shopify_payments_bank_accounts access scope.

A bank account that can receive payouts.

Anchor to accountNumberLastDigitsaccountNumberLastDigits
•String!
non-null

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

•String

The name of the bank.

•CountryCode!
non-null

The country of the bank.

•DateTime!
non-null

The date that the bank account was created.

•CurrencyCode!
non-null

The currency of the bank account.

•ID!
non-null

A globally-unique ID.

•ShopifyPaymentsPayoutConnection!
non-null

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

Arguments

•ShopifyPaymentsPayoutTransactionType

Filter the direction of the payout.

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•Boolean
Default:false

Reverse the order of the underlying list.

•PayoutSortKeys
Default:ISSUED_AT

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
•float
Anchor to bank_account
•string
Anchor to currency
•string
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to issued_at
•time
Anchor to ledger_type
•string
•string
Anchor to transaction_dates
•time
•ID

The ID of a saved search. The search’s query string is used as the query argument.


•ShopifyPaymentsBankAccountStatus!
non-null

The status of the bank account.


Was this section helpful?

•interface

Was this section helpful?