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.

payoutStatusStatus NameDescription
10pendingProviderActionThe payout request is being processed by the provider. No further action is required at this time.
11pendingMerchantActionThe payout request is pending until the merchant takes action.
12pendingRecipientActionThe payout request is pending until the recipient takes action.
20completedThe payout request has been completed. Funds are available for the recipient. No further action is required.
30expiredThe payout request has expired. The payout is no longer available for the recipient.
40canceledThe payout request has been canceled. The payout is no longer available for the recipient.
50returnedThe payout request has failed, most commonly due to rejection by the recipient’s bank. The payout is no longer available for the recipient.
90failedThe payout request has failed. For more details about what failed, see the providerResponse parameter in the API response.

Spendback status (spendbackStatus)

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

spendbackStatusStatus nameDescription
10pendingThe spendback request is being processed by the provider. No further action is required at this time.
20completedThe spendback request has been completed. The recipient's payout account has been debited. No further action is required.
30reviewThe spendback request is pending approval in the provider's portal.
40expiredThe spendback request has expired.
50canceledThe spendback request has been canceled.
90failedThe spendback request has failed. For more details about what failed, see the providerResponse parameter in the API response.

Transfer status (transferStatus)

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

transferStatusStatus NameDescription
10availablePayout money has been transferred. No further action is required at this time.
20completedThe recipient has claimed available funds.
Note: This status is not available for all payout providers.
90failedAn error occurred during the transfer.

Did this page help you?