v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB

Accounts

Payouts

List payouts for a sub account

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

get/accounts/{id}/payouts

Path parameters

idstring required

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

the account id of one of your sub accounts

Query parameters

ascendingboolean

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.

limitinteger

Control how many payouts are returned in the result list. The max limit we allow is 50.

Example:20

startsAfterstring

Example:po_01FCTS1XMKH9FF43CAFA4CXT3P_1641912473

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.

startDatestring date

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

endDatestring date

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

startTimestampinteger

Example:1641859200

The start timestamp (inclusive), it must be before the endTimestamp.

endTimestampinteger

Example:1641945599

The timestamp when to return payouts up to (inclusive), it must be after the startTimestamp.

Response

Payouts were retrieved successfully

paginationTokenstring nullable

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 response

{
  "payouts": [
    {
      "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"
      }
    }
  ],
  "paginationToken": "po_01FCTS1XMKH9FF43CAFA4CXT3P"
}