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 FieldsFields

Anchor to accountNumberLastDigitsaccountNumberLastDigits
•String!
non-null

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

Anchor to bankNamebankName
•String

The name of the bank.

Anchor to countrycountry
•CountryCode!
non-null

The country of the bank.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date that the bank account was created.

Anchor to currencycurrency
•CurrencyCode!
non-null

The currency of the bank account.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to payoutspayouts
•ShopifyPaymentsPayoutConnection!
non-null

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

Arguments

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to queryquery
•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
Anchor to amount
•float
Anchor to bank_account
•string
Anchor to currency
•string
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to issued_at
•time
Anchor to ledger_type
•string
Anchor to status
•string
Anchor to transaction_dates
•time
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId
•ID

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

Anchor to sortKeysortKey
•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.

Anchor to transactionTypetransactionType
•ShopifyPaymentsPayoutTransactionType

Filter the direction of the payout.

Anchor to statusstatus
•ShopifyPaymentsBankAccountStatus!
non-null

The status of the bank account.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?