GET
/
payments
/
payouts
curl --request GET \
  --url https://api.rootfi.dev/v3/payments/payouts \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "amount": "100.00",
      "created_at": "2024-01-22T05:07:31.000Z",
      "description": "Payment Description",
      "currency_id": "USD",
      "status": "SUCCESS"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

The Payouts Data Model is designed to streamline the management and retrieval of payouts information across various payment platforms.

Authorizations

​
api_key
string
header
required

Query Parameters

​
limit
integer | null

The number of payouts links you want to retrieve

​
next
string | null

The next page of objects to retrieve

​
prev
string | null

The previous page of objects to retrieve

​
select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

​
rootfi_updated_at[gte]
string | null

Filter by rootfi_updated_at Greater than or Equal To.

​
rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator].

​
include_deleted_records
string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

​
return_count
string | null

Return the count of the objects. Supported values are true and false

​
sort[rootfi_created_at]
enum<string>

Sort by rootfi_created_at

Available options:
ASC,
DESC
​
sort[rootfi_updated_at]
enum<string>

Sort by rootfi_updated_at

Available options:
ASC,
DESC

Response

200
application/json

The data of the payments endpoint.