List All Payouts - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Header Params

Accept

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

status

string

optional

Only return payouts that have the given status: pending, paid, failed, or canceled.

created

object

optional

A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:

gt

string

optional

Return results where the created field is greater than this value.

gte

string

optional

Return results where the created field is greater than or equal to this value.

lt

string

optional

Return results where the created field is less than this value.

lte

string

optional

Return results where the created field is less than or equal to this value.

destination

string

optional

The ID of an external account - only return payouts sent to this external account.

ending_before

string

optional

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.

limit

integer

optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

starting_after

string

optional

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Example

{
  "status": "string",
  "created": {
    "gt": "string",
    "gte": "string",
    "lt": "string",
    "lte": "string"
  },
  "destination": "string",
  "ending_before": "string",
  "limit": 0,
  "starting_after": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://apitest.wooshpay.com/v1/payouts/list' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "status": "string",
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "destination": "string",
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}'

Responses

🟢200OK

application/json

Body

object

string

optional

Default:

"list"

url

string

optional

has_more

boolean

optional

data

array [object {11}]

optional

id

string

optional

object

string

optional

api_version

null

optional

application

null

optional

created

integer

optional

description

string

optional

enabled_events

array[string]

optional

livemode

boolean

optional

metadata

object

optional

status

string

optional

url

string

optional

Example

{
  "object": "list",
  "url": "/v1/payouts",
  "has_more": false,
  "data": [
    {
      "id": "po_1M9OPNL6kclEVx6MVxzULjsL",
      "object": "payout",
      "amount": 1100,
      "created": 1669707553,
      "currency": "eur",
      "destination": "ba_xxxxxxxxxx",
      "failure_balance_transaction": null,
      "failure_code": null,
      "failure_message": null,
      "livemode": false,
      "metadata": {},
      "method": "standard",
      "original_payout": null,
      "reversed_by": null,
      "source_type": "card",
      "statement_descriptor": null,
      "status": "in_transit",
      "type": "bank_account"
    }
  ]
}