API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

ShopifyPaymentsPayoutStatus enum

Version unstable

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2021-01 (Release candidate)

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2020-10 (Latest)

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2020-07

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2020-04

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2020-01

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2019-10 (Unsupported)

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2019-07 (Unsupported)

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus

Version 2019-04 (Unsupported)

The transfer status of the payout.

Values

CANCELED

The payout has been canceled by Shopify.

FAILED

The payout has been declined by the bank.

IN_TRANSIT

The payout has been submitted to the bank.

PAID

The payout has been successfully deposited into the bank.

SCHEDULED

The payout has been created and had transactions assigned to it, but it has not yet been submitted to the bank.

Types that return ShopifyPaymentsPayoutStatus