Payouts

List payouts

get

Get a paginated list of payouts with optional filtering

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Query parameters

limitintegerOptional

Number of items to return

Default: 100

afterstringOptional

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestringOptional

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

statusstring · enumOptional

Filter by payout status

Possible values:

customer_idstringOptional

Filter by customer ID

invoice_idstringOptional

Filter by invoice ID

start_datestringOptional

Filter by start date (RFC3339 format)

end_datestringOptional

Filter by end date (RFC3339 format)

Responses

200

OK

application/json

end_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

has_next_pagebooleanOptionalExample: true

has_previous_pagebooleanOptional

start_cursorstringOptionalExample: gaFpxBACEaXBVABEYbHG+X9LyLnH

400

Bad Request

application/json

get/payouts

GET /payouts HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "arrival_date": "text",
      "created_at": "text",
      "customer_id": "text",
      "fees": [
        {
          "amount": 1,
          "covered_by_customer": true,
          "name": "text",
          "type": "unspecified"
        }
      ],
      "id": "text",
      "status": "unspecified",
      "sub_total": 1,
      "total": 1
    }
  ],
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "has_previous_page": false,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Get a payout

get

Get payout details by ID

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Payout ID

Responses

200

OK

application/json

arrival_datestringOptional

created_atstringOptional

customer_idstringOptional

idstringOptional

statusstring · enumOptionalPossible values:

sub_totalnumberOptional

totalnumberOptional

404

Not Found

application/json

get/payouts/{id}

GET /payouts/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "arrival_date": "text",
  "created_at": "text",
  "customer_id": "text",
  "fees": [
    {
      "amount": 1,
      "covered_by_customer": true,
      "name": "text",
      "type": "unspecified"
    }
  ],
  "id": "text",
  "status": "unspecified",
  "sub_total": 1,
  "total": 1
}

Get a payout transactions

get

Get payout transactions by ID

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

Payout ID

Responses

200

OK

application/json

404

Not Found

application/json

get/payouts/{id}/transactions

GET /payouts/{id}/transactions HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "payout": {
    "arrival_date": "text",
    "created_at": "text",
    "customer_id": "text",
    "fees": [
      {
        "amount": 1,
        "covered_by_customer": true,
        "name": "text",
        "type": "unspecified"
      }
    ],
    "id": "text",
    "status": "unspecified",
    "sub_total": 1,
    "total": 1
  },
  "transactions": [
    {
      "description": "text",
      "direction": "credit",
      "failure_reason": "text",
      "id": "text",
      "method": "standard_ach",
      "status": "created",
      "sub_total": 1,
      "total": 1
    }
  ]
}