Skip to main content
Anchor to PayoutSortKeys

PayoutSortKeys

enum

The set of valid sort keys for the Payout query.

Anchor to Valid valuesValid values

Anchor to ADJUSTMENT_GROSSADJUSTMENT_GROSS

Sort by the adjustment_gross value.

Anchor to ADVANCE_GROSSADVANCE_GROSS

Sort by the advance_gross value.

Anchor to AMOUNTAMOUNT

Sort by the amount value.

Anchor to CHARGE_GROSSCHARGE_GROSS

Sort by the charge_gross value.

Anchor to DUTIES_GROSSDUTIES_GROSS

Sort by the duties_gross value.

Anchor to FEE_AMOUNTFEE_AMOUNT

Sort by the fee_amount value.

Anchor to IDID

Sort by the id value.

Anchor to ISSUED_ATISSUED_AT

Sort by the issued_at value.

Anchor to REFUND_GROSSREFUND_GROSS

Sort by the refund_gross value.

Anchor to SHIPPING_LABEL_GROSSSHIPPING_LABEL_GROSS

Sort by the shipping_label_gross value.

Anchor to STATUSSTATUS

Sort by the status value.

Was this section helpful?

Anchor to FieldsFields

Anchor to ShopifyPaymentsAccount.payouts(sortKey)ShopifyPaymentsAccount.payouts(sortKey)
•ARGUMENT

Financial account information for merchants using Shopify Payments. Tracks current balances across all supported currencies, payout schedules, and ShopifyPaymentsBalanceTransaction records.

The account includes configuration details such as ShopifyPaymentsBankAccount objects for receiving ShopifyPaymentsPayout transfers, statement descriptors that appear on customer credit card statements, and the ShopifyPaymentsPayoutSchedule that determines when funds transfer to your bank. Access balance transactions to review individual charges, refunds, and adjustments that affect your account balance. Query payouts to track money movement between your Shopify Payments balance and bank accounts.

Anchor to ShopifyPaymentsBankAccount.payouts(sortKey)ShopifyPaymentsBankAccount.payouts(sortKey)
•ARGUMENT

A bank account that can receive payouts.

Was this section helpful?