--- title: "Create a manual payout for a sub account" method: POST path: "/accounts/{id}/payouts" tags: ["Accounts", "Payouts"] --- # Create a manual payout for a sub account `POST /accounts/{id}/payouts` Used to create manual payouts for a specified sub account. This API can only be accessed for `NonHosted` sub accounts that are configured for manual payouts. **Note** that the following requirements must be met: - the `payoutMethodId` supplied must have status equal to `Valid` - `amount` must be greater than or equal to the minimum configured payout amount for the account (e.g. £100) - `verification.status` cannot be `Required` on the account ## Path parameters - `id` string, required ## Request body - CreatePayoutRequestBody - `amount` integer, required — The amount (in minor units) to payout - `currency` string, required — The three-letter ISO currency code - `payoutMethodId` string, required — The payout method to send the payout amount to - `metadata` object, nullable — Used to attach any custom key-value data to the payout. You can have a maximum of 5 pieces of metadata. ## Response `200` Successfully created payout - PayoutResponse - `id` string — The id of the payout - `paymentsTakenDate` string, date — Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout. - `paymentsTakenDateFrom` string, date — 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 - `paymentsTakenDateTo` string, date — 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 - `amount` integer — The total amount that was paid out, minus any fees - `currency` string — The ISO code of the payout currency - `status` 'Completed' | 'Failed' | 'PendingReview' | 'InProgress' | 'Returned' — The status of the payout - `scheduleType` 'Automatic' | 'Manual' — Whether the payout was issued automatically by Ryft or manually requested. - `payoutMethod` PayoutPayoutMethodResponse, nullable - `id` string — The payout method the payout will be or was sent to - `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. - `bankIdType` 'RoutingNumber' | 'SwiftCode' | 'SortCode' | 'BSBCode' | 'BankCode', nullable - `bankId` string, nullable — 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 - `bankName` string, nullable — The name of the bank that the bank account is with - `branchIdType` 'TransitNumber', nullable — The types of branch ID for bank accounts. - `branchId` string, nullable — The id of the branch that the bank account is with - `swiftCode` string, nullable — The Swift code / BIC of the bank - `accountNumberType` 'Iban' | 'UnitedKingdom' | 'Domestic' - `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 - `failureReason` string, nullable — If the payout is in the 'Failed' status, this is an additional reason to explain why - `payoutCalculation` PayoutCalculationResponse — 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 - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `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 - `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' - `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' - `platformChargebacksAmount` integer — The total amount of money debited via chargebacks raised for your sub accounts payments, in the minor units of the payout currency. - `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. - `transferredInAmount` integer — The total amount of money credited via money transferred into your account, in the minor units of the payout currency. - `transferredOutAmount` integer — The total amount of money debited via money transferred out of your account, in the minor units of the payout currency. - `payoutAmount` integer — The total amount of money paid to you or your sub account, in the minor units of the payout currency - `currency` string — The ISO code of the payout currency - `numberOfPaymentsCaptured` integer — The total number of payments captured by you or your sub account - `numberOfPaymentsRefunded` integer — The total number of payments refunded by you or your sub account - `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 - `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 - `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 - `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 - `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 - `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 - `numberOfChargebacks` integer — The total number of chargebacks that were raised for your accounts payments. - `numberOfChargebackReversals` integer — The total number of chargebacks that were reversed for your accounts payments. - `numberOfPlatformChargebacks` integer — The total number of chargebacks that were raised for your sub accounts payments. - `numberOfPlatformChargebackReversals` integer — The total number of chargebacks that were reversed for your sub accounts payments. - `numberOfTransfersIn` integer — The total number of transfers made that transferred funds into your account. - `numberOfTransfersOut` integer — The total number of transfers made that transferred funds out of your account. - `numberOfCustomers` integer — The total number of unique customers that made payments to you or your sub accounts - `numberOfNewCustomers` integer, nullable — The total number of unique customers that made their first payments to you or your sub accounts on the date these payments were made - `scheme` 'Ach' | 'Bacs' | 'Certis' | 'Chaps' | 'DataclearingenAch' | 'DirectEntry' | 'ElectronicFundsTransfer' | 'Elixir' | 'Fast' | 'FedAch' | 'Fps' | 'GiroZrt' | 'NorwegianInterbankClearingSystem' | 'Swift' | 'Sepa' | 'SepaInstant' | 'StraksclearingInstant' | 'SwissInterbankClearing' | 'TransFonDSentAch', nullable — The scheme used to payout to your account - `createdTimestamp` integer — The epoch timestamp (seconds) when the payout was created - `scheduledTimestamp` integer — epoch timestamp of when the payout is scheduled to be paid - `completedTimestamp` integer, nullable — epoch timestamp of when the payout moved to the 'Completed' status, i.e. when it was paid out - `metadata` object, nullable — Your custom key-value data for the payout. You can have a maximum of 5 pieces of metadata. ## Other responses - `400` — One or more inputs are invalid - `404` — The given resource could not be found - `500` — An unexpected error occurred when executing this request --- [API](https://skmtc.net/ryftpay/apis/ryft-payment-api.md) · [All operations](https://skmtc.net/ryftpay/apis/ryft-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ryftpay/ryft-payment-api/versions/a042f64d4305/schema)