Constant payouts values

When querying payouts data, the following numerical values are returned which represent the corresponding constant value.

Payout status (payoutStatus)

The following table displays the commonly used codes for the payout status.

payoutStatus	Status Name	Description
10	pendingProviderAction	The payout request is being processed by the provider. No further action is required at this time.
11	pendingMerchantAction	The payout request is pending until the merchant takes action.
12	pendingRecipientAction	The payout request is pending until the recipient takes action.
20	completed	The payout request has been completed. Funds are available for the recipient. No further action is required.
30	expired	The payout request has expired. The payout is no longer available for the recipient.
40	canceled	The payout request has been canceled. The payout is no longer available for the recipient.
50	returned	The payout request has failed, most commonly due to rejection by the recipient’s bank. The payout is no longer available for the recipient.
90	failed	The payout request has failed. For more details about what failed, see the `providerResponse` parameter in the API response.

The following table displays the commonly used codes for the spendback status.

spendbackStatus	Status name	Description
10	pending	The spendback request is being processed by the provider. No further action is required at this time.
20	completed	The spendback request has been completed. The recipient's payout account has been debited. No further action is required.
30	review	The spendback request is pending approval in the provider's portal.
40	expired	The spendback request has expired.
50	canceled	The spendback request has been canceled.
90	failed	The spendback request has failed. For more details about what failed, see the `providerResponse` parameter in the API response.

The following table displays the commonly used codes for the transfer status.

transferStatus	Status Name	Description
10	available	Payout money has been transferred. No further action is required at this time.
20	completed	The recipient has claimed available funds. Note: This status is not available for all payout providers.
90	failed	An error occurred during the transfer.

Updated over 1 year ago