# List payouts for a sub account

Used to fetch a paginated list of payouts for the given sub account

Endpoint: GET /accounts/{id}/payouts
Version: 1.1.0
Security: secretApiKeyAuth

## Path parameters:

  - `id` (string, required)
    the account id of one of your sub accounts
    Example: "ac_b83f2653-06d7-44a9-a548-5825e8186004"

## Query parameters:

  - `ascending` (boolean)
    Control the order (newest or oldest) in which the payouts are returned. false will arrange the results with newest first whereas true shows oldest first.

  - `limit` (integer)
    Control how many payouts are returned in the result list. The max limit we allow is 50.
    Example: 20

  - `startsAfter` (string)
    A token to identify where to resume a subsequent paginated query. The value of the paginationToken field from that response should be supplied here in order to retrieve the next page of results.
    Example: "po_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473"

  - `startTimestamp` (integer)
    The start timestamp (inclusive), it must be before the endTimestamp.
    Example: 1641859200

  - `endTimestamp` (integer)
    The timestamp when to return payouts up to (inclusive), it must be after the startTimestamp.
    Example: 1641945599

  - `startDate` (string)
    The date when payments were taken to search for payouts from (inclusive), in the format yyyy-MM-dd

  - `endDate` (string)
    The date when payments were taken to search for payouts to (inclusive), in the format yyyy-MM-dd

## Response 200 fields (application/json):

  - `payouts` (array)

  - `payouts.id` (string)
    The id of the payout
    Example: "po_01FJ1H0023R1AHM77YQ75RMKE7"

  - `payouts.amount` (integer)
    The total amount that was paid out, minus any fees
    Example: 9750

  - `payouts.currency` (string)
    The ISO code of the payout currency
    Example: "GBP"

  - `payouts.status` (string)
    The status of the payout
    Enum: "Completed", "Failed", "Pending", "PendingAccountVerification", "PendingTransactionVerification", "PendingPayoutMethodAction", "PendingAccountAction", "InProgress", "Cancelled", "Expired", "Recalled", "Returned"

  - `payouts.scheduleType` (string)
    Whether the payout was issued automatically by Ryft or manually requested.
    Enum: "Automatic", "Manual"

  - `payouts.payoutMethod` (object,null)

  - `payouts.payoutMethod.id` (string)
    The payout method the payout will be or was sent to
    Example: "pm_01FCTS1XMKH9FF43CAFA4CXT3P"

  - `payouts.payoutMethod.bankAccount` (object)
    The bank details that the payout will be or was sent to. Note that these may be different to those currently assigned to the payout method id, if the payout method has since been updated.

  - `payouts.payoutMethod.bankAccount.bankIdType` (string,null)
    Enum: "RoutingNumber", "SwiftCode", "SortCode"

  - `payouts.payoutMethod.bankAccount.bankId` (string,null)
    The id of the bank that the bank account is with. This is the sort code, swift code or routing number of the bank, depending on the currency + country of the payout method
    Example: "123456"

  - `payouts.payoutMethod.bankAccount.bankName` (string,null)
    The name of the bank that the bank account is with
    Example: "Ryft Bank Ltd"

  - `payouts.payoutMethod.bankAccount.accountNumberType` (string)
    Enum: "Iban", "UnitedKingdom", "UnitedStates"

  - `payouts.payoutMethod.bankAccount.last4` (string)
    The last 4 digits of the account number for the bank account. This is the account number or IBAN of the bank account, depending on the currency + country of the payout method
    Example: "0001"

  - `payouts.failureReason` (string,null)
    If the payout is in the 'Failed' status, this is an additional reason to explain why
    Example: "InvalidPayoutMethod"

  - `payouts.scheme` (string,null)
    The scheme used to payout to your account
    Enum: "Ach", "Bacs", "Chaps", "Fps", "Swift", "Sepa", "SepaInstant"

  - `payouts.createdTimestamp` (integer)
    The epoch timestamp (seconds) when the payout was created
    Example: 1631696701

  - `payouts.scheduledTimestamp` (integer)
    epoch timestamp of when the payout is scheduled to be paid
    Example: 1631696701

  - `payouts.completedTimestamp` (integer,null)
    epoch timestamp of when the payout moved to the 'Completed' status, i.e. when it was paid out
    Example: 1631696701

  - `payouts.metadata` (object,null)
    Your custom key-value data for the payout. You can have a maximum of 5 pieces of metadata.
    Example: {"orderId":"1","customerId":"123"}

  - `payouts.paymentsTakenDate` (string)
    Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout.
    Example: "2021-10-14"

  - `payouts.paymentsTakenDateFrom` (string)
    Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout. The date on which payments within this payout began, in the format yyyy-MM-dd
    Example: "2021-10-14"

  - `payouts.paymentsTakenDateTo` (string)
    Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout. The date on which payments within this payout end, in the format yyyy-MM-dd
    Example: "2021-10-14"

  - `payouts.payoutCalculation` (object)
    Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout.
An object containing a breakdown of how the payout was calculated

  - `payouts.payoutCalculation.paymentsCapturedAmount` (integer)
    The total amount of money credited via captured payments by you or by your sub account, in the minor units of the payout currency
    Example: 10000

  - `payouts.payoutCalculation.paymentsRefundedAmount` (integer)
    The total amount of money debited via refunds of payments by you or by your sub account, in the minor units of the payout currency
    Example: 50

  - `payouts.payoutCalculation.paymentsSplitAmount` (integer)
    The total amount of money debited from you via payments split with your sub accounts, in the minor units of the payout currency Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot split payments with others
    Example: 10000

  - `payouts.payoutCalculation.paymentsSplitRefundedAmount` (integer)
    The total amount of money credited to you via refunds of payments split with your sub accounts, in the minor units of the payout currency  Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot split payments with others
    Example: 50

  - `payouts.payoutCalculation.splitPaymentsAmount` (integer)
    The total amount of money credited via split payments that your sub account has received, in the minor units of the payout currency Note that this field is only applicable to your sub accounts payouts, as they have payments split with them
    Example: 10000

  - `payouts.payoutCalculation.splitPaymentsRefundedAmount` (integer)
    The total amount of money debited via refunds of split payments that your sub account has received, in the minor units of the payout currency Note that this field is only applicable to your sub accounts payouts, as they have payments split with them
    Example: 50

  - `payouts.payoutCalculation.platformFeesCollectedAmount` (integer)
    The total amount of money credited to you via platform fees taken from sub accounts, in the minor units of the payout currency. Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot earn platform fees

  - `payouts.payoutCalculation.platformFeesRefundedAmount` (integer)
    The total amount of money debited from you via platform fees refunded to sub accounts, in the minor units of the payout currency. Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot earn platform fees

  - `payouts.payoutCalculation.platformFeesPaidAmount` (integer)
    The total amount of money debited via platform fees paid to you by your sub accounts, in the minor units of the payout currency. Note that this field is only applicable to your sub accounts payouts, as they pay platform fees
    Example: 100

  - `payouts.payoutCalculation.processingFeesPaidAmount` (integer)
    The total amount of money debited via processing fees paid by either you or your sub accounts, in the minor units of the payout currency. Note that this is applicable to whoever pays the processing fee on payments, and includes fees from chargebacks
    Example: 100

  - `payouts.payoutCalculation.chargebacksAmount` (integer)
    The total amount of money debited via chargebacks raised for your payments, in the minor units of the payout currency. Note that this value excludes chargebacks raised for your sub account payments - see 'platformChargebacksAmount'
    Example: 100

  - `payouts.payoutCalculation.chargebackReversalsAmount` (integer)
    The total amount of money credited via reversals of chargebacks raised for your payments, in the minor units of the payout currency. Note that this value excludes chargebacks raised for your sub account payments - see 'platformChargebackReversalsAmount'
    Example: 100

  - `payouts.payoutCalculation.platformChargebacksAmount` (integer)
    The total amount of money debited via chargebacks raised for your sub accounts payments, in the minor units of the payout currency.
    Example: 100

  - `payouts.payoutCalculation.platformChargebackReversalsAmount` (integer)
    The total amount of money credited via reversals of chargebacks raised for your sub accounts payments, in the minor units of the payout currency.
    Example: 100

  - `payouts.payoutCalculation.transferredInAmount` (integer)
    The total amount of money credited via money transferred into your account, in the minor units of the payout currency.
    Example: 100

  - `payouts.payoutCalculation.transferredOutAmount` (integer)
    The total amount of money debited via money transferred out of your account, in the minor units of the payout currency.
    Example: 100

  - `payouts.payoutCalculation.payoutAmount` (integer)
    The total amount of money paid to you or your sub account, in the minor units of the payout currency
    Example: 9750

  - `payouts.payoutCalculation.numberOfPaymentsCaptured` (integer)
    The total number of payments captured by you or your sub account
    Example: 100

  - `payouts.payoutCalculation.numberOfPaymentsRefunded` (integer)
    The total number of payments refunded by you or your sub account
    Example: 1

  - `payouts.payoutCalculation.numberOfPaymentsSplit` (integer)
    The total number of payments split with your sub accounts Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot split payments with others
    Example: 100

  - `payouts.payoutCalculation.numberOfPaymentsSplitRefunded` (integer)
    The total number of refunds for payments split with your sub accounts Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot split payments with others
    Example: 1

  - `payouts.payoutCalculation.numberOfSplitPayments` (integer)
    The total number of split payments that your sub account has received Note that this field is only applicable to your sub accounts payouts, as they have payments split with them
    Example: 100

  - `payouts.payoutCalculation.numberOfSplitPaymentsRefunded` (integer)
    The total number of split payments that your sub account has received Note that this field is only applicable to your sub accounts payouts, as they have payments split with them
    Example: 1

  - `payouts.payoutCalculation.numberOfPlatformFeesCollected` (integer)
    The total number of platform fees collected. Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot earn platform fees

  - `payouts.payoutCalculation.numberOfPlatformFeesRefunded` (integer)
    The total number of platform fees refunded. Note that this field is only applicable to your own payouts as the standard account, as sub accounts cannot earn platform fees

  - `payouts.payoutCalculation.numberOfChargebacks` (integer)
    The total number of chargebacks that were raised for your accounts payments.

  - `payouts.payoutCalculation.numberOfChargebackReversals` (integer)
    The total number of chargebacks that were reversed for your accounts payments.

  - `payouts.payoutCalculation.numberOfPlatformChargebacks` (integer)
    The total number of chargebacks that were raised for your sub accounts payments.

  - `payouts.payoutCalculation.numberOfPlatformChargebackReversals` (integer)
    The total number of chargebacks that were reversed for your sub accounts payments.

  - `payouts.payoutCalculation.numberOfTransfersIn` (integer)
    The total number of transfers made that transferred funds into your account.

  - `payouts.payoutCalculation.numberOfTransfersOut` (integer)
    The total number of transfers made that transferred funds out of your account.

  - `payouts.payoutCalculation.numberOfCustomers` (integer)
    The total number of unique customers that made payments to you or your sub accounts
    Example: 74

  - `payouts.payoutCalculation.numberOfNewCustomers` (integer,null)
    The total number of unique customers that made their first payments to you or your sub accounts on the date these payments were made
    Example: 50

  - `paginationToken` (string)
    A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return.
    Example: "po_01FCTS1XMKH9FF43CAFA4CXT3P"

## Response 400 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"

## Response 500 fields (application/json):

  - `requestId` (string)
    Example: "b83f2653-06d7-44a9-a548-5825e8186004"

  - `code` (string)
    Example: "400"

  - `errors` (array)

  - `errors.message` (string)
    Example: "Required property 'amount' not found in JSON"