ShopifyPaymentsAccount
Returns Shopify Payments account information, including balances and payouts.
View-Specific Information
Select
The cmdlet processes all filters client-side within the cmdlet. The following query is the only one processed server side:
SELECT * FROM ShopifyPaymentsAccount
Columns
Name | Type | References | Description |
Id [KEY] | String | A globally-unique ID. | |
Activated | Bool | Whether the Shopify Payments setup is completed. | |
Country | String | The Shopify Payments account country. | |
Onboardable | Bool | Whether the Shopify Payments account can be onboarded. | |
DefaultCurrency | String | The default payout currency for the Shopify Payments account. | |
PayoutStatementDescriptor | String | The descriptor used for payouts. The descriptor appears on a merchant's bank statement when they receive a payout. | |
FraudSettingsDeclineChargeOnAvsFailure | Bool | Decline a charge if there is an AVS failure. | |
FraudSettingsDeclineChargeOnCvcFailure | Bool | Decline a charge if there is an CVC failure. | |
NotificationSettingsPayouts | Bool | Receive email notifications when new payouts are sent or payouts fail. | |
PayoutScheduleInterval | String | The interval at which payouts are sent to the connected bank account. | |
PayoutScheduleMonthlyAnchor | Int | The day of the month funds will be paid out. The value can be any day of the month from the 1st to the 31st. If the payment interval is set to monthly, this value will be used. Payouts scheduled between 29-31st of the month are sent on the last day of shorter months. | |
PayoutScheduleWeeklyAnchor | String | The day of the week funds will be paid out. The value can be any weekday from Monday to Friday. If the payment interval is set to weekly, this value will be used. |