Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Accounts
Payouts

Create a manual payout for a sub account

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
post/accounts/{id}/payouts

Path parameters

idstring required
Example:ac_b83f2653-06d7-44a9-a548-5825e8186004

the account id of one of your sub accounts

Request body

amountinteger required

The amount (in minor units) to payout

currencystring required

The three-letter ISO currency code

payoutMethodIdstring required

The payout method to send the payout amount to

metadataobject nullable

Used to attach any custom key-value data to the payout. You can have a maximum of 5 pieces of metadata.

Example request

{
  "amount": 5000,
  "currency": "GBP",
  "payoutMethodId": "pm_01FCTS1XMKH9FF43CAFA4CXT3P",
  "metadata": {
    "orderId": "1",
    "customerId": "123"
  }
}

Response

Successfully created payout

idstring

The id of the payout

paymentsTakenDatestring date

Deprecated - please use the 'payoutId' param on the /balance-transactions endpoint to see transactions in a payout.

paymentsTakenDateFromstring 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

paymentsTakenDateTostring 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

amountinteger

The total amount that was paid out, minus any fees

currencystring

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.

failureReasonstring nullable

If the payout is in the 'Failed' status, this is an additional reason to explain why

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

createdTimestampinteger

The epoch timestamp (seconds) when the payout was created

scheduledTimestampinteger

epoch timestamp of when the payout is scheduled to be paid

completedTimestampinteger nullable

epoch timestamp of when the payout moved to the 'Completed' status, i.e. when it was paid out

metadataobject nullable

Your custom key-value data for the payout. You can have a maximum of 5 pieces of metadata.

Example response

{
  "id": "po_01FJ1H0023R1AHM77YQ75RMKE7",
  "paymentsTakenDate": "2021-10-14",
  "paymentsTakenDateFrom": "2021-10-14",
  "paymentsTakenDateTo": "2021-10-14",
  "amount": 9750,
  "currency": "GBP",
  "status": "InProgress",
  "scheduleType": "Automatic",
  "payoutMethod": {
    "id": "pm_01FCTS1XMKH9FF43CAFA4CXT3P",
    "bankAccount": {
      "bankIdType": "SortCode",
      "bankId": "123456",
      "bankName": "Ryft Bank Ltd",
      "branchIdType": "TransitNumber",
      "branchId": "11122",
      "swiftCode": "NAIAGB21",
      "accountNumberType": "UnitedKingdom",
      "last4": "0001"
    }
  },
  "failureReason": "InvalidPayoutMethod",
  "payoutCalculation": {
    "paymentsCapturedAmount": 10000,
    "paymentsRefundedAmount": 50,
    "paymentsSplitAmount": 10000,
    "paymentsSplitRefundedAmount": 50,
    "splitPaymentsAmount": 10000,
    "splitPaymentsRefundedAmount": 50,
    "platformFeesPaidAmount": 100,
    "processingFeesPaidAmount": 100,
    "chargebacksAmount": 100,
    "chargebackReversalsAmount": 100,
    "platformChargebacksAmount": 100,
    "platformChargebackReversalsAmount": 100,
    "transferredInAmount": 100,
    "transferredOutAmount": 100,
    "payoutAmount": 9750,
    "currency": "GBP",
    "numberOfPaymentsCaptured": 100,
    "numberOfPaymentsRefunded": 1,
    "numberOfPaymentsSplit": 100,
    "numberOfPaymentsSplitRefunded": 1,
    "numberOfSplitPayments": 100,
    "numberOfSplitPaymentsRefunded": 1,
    "numberOfCustomers": 74,
    "numberOfNewCustomers": 50
  },
  "scheme": "Fps",
  "createdTimestamp": 1631696701,
  "scheduledTimestamp": 1631696701,
  "completedTimestamp": 1631696701,
  "metadata": {
    "orderId": "1",
    "customerId": "123"
  }
}