GET
/
payouts
curl --request GET \
  --url https://api.sulu.sh/v0/payouts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "object": "payout",
      "organizationId": "<string>",
      "status": "pending",
      "description": "<string>",
      "amountInCents": 123,
      "currency": "<string>",
      "method": "bank_transfer",
      "sourceId": "<string>",
      "destinationId": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "platformFee": 123,
      "methodFee": 123,
      "transactionId": "<string>",
      "failureCode": "<string>",
      "failureMessage": "<string>",
      "transferredAmountInCents": 123
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
organizationId
string
required

Unique identifier for an organization

​
status
enum<string>
Available options:
pending,
success,
failed,
cancelled
​
startTime
string
​
endTime
string
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

200
application/json
List of payouts
​
object
enum<string>
Available options:
list
​
data
object[]
​
pagination
object

Offset-based pagination response.