Skip to main content
POST
/
psp-payouts
List Stripe Payouts
curl --request POST \
  --url https://nestvet.com/api/1.1/wf/psp-payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": "<string>",
  "limit": 123,
  "offset": 123,
  "clinic": "<string>",
  "starting_after": "<string>",
  "created.gte": 123,
  "created.lte": 123,
  "status": "pending"
}
'
{
  "data": [
    {
      "id": "<string>",
      "object": "payout",
      "amount": 123,
      "arrival_date": 123,
      "automatic": true,
      "balance_transaction": "<string>",
      "created": 123,
      "currency": "<string>",
      "description": "<string>",
      "destination": "<string>",
      "livemode": true,
      "metadata": {},
      "method": "<string>",
      "reconciliation_status": "<string>",
      "source_type": "<string>",
      "status": "<string>",
      "trace_id": {
        "status": "<string>",
        "value": "<string>"
      },
      "type": "<string>"
    }
  ],
  "has_more": true
}

Authorizations

Authorization
string
header
required

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

Body

application/json
organization
string
required
limit
integer<int32>
required
offset
integer<int32>
required
clinic
string
starting_after
string
created.gte
integer<int64>

Unix timestamp

created.lte
integer<int64>

Unix timestamp

status
enum<string>
Available options:
pending,
paid,
failed,
canceled

Response

200 - application/json

Stripe payouts response

data
object[]
has_more
boolean