Transactions

List transactions

get

Get a paginated list of transactions with optional filtering

Authorizations

Query parameters

limitintegerOptional

Number of items to return

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.

typestring · enumOptional

Filter by payment type

Possible values:

statusstring · enumOptional

Filter by payment status

Possible values:

customer_idstringOptional

Filter by customer ID

invoice_idstringOptional

Filter by invoice ID

payment_methodstring · enumOptional

Filter by payment method

Possible values:

created_at_startstringOptional

Filter by creation date start (RFC3339 format)

created_at_endstringOptional

Filter by creation date end (RFC3339 format)

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /payments HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: YOUR_API_KEY
Accept: */*

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