Skip to main content
GET
/
transactions
List all transactions
curl --request GET \
  --url https://psn-api.paystub.dev/transactions \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "site_id": 123,
      "user_id": 123,
      "order_id": 123,
      "processor": "Stripe",
      "processor_id": "<string>",
      "processor_response": "<string>",
      "amount": 123,
      "type": "Sale",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "links": {
    "first": "https://api.paystub.dev/transactions?page=1",
    "last": "https://api.paystub.dev/transactions?page=1",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "https://api.paystub.dev/transactions",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}

Authorizations

Authorization
string
header
required

Use your API token

Query Parameters

filter[status]
enum<string>

Filter by status

Available options:
pending,
processing,
completed,
failed
filter[type]
enum<string>

Filter by type

Available options:
Sale,
Refund,
Void,
Free
filter[processor]
enum<string>

Filter by payment processor

Available options:
Stripe,
NMI,
Coinbase
filter[order_id]
integer

Filter by order ID

filter[amount_min]
number

Filter by minimum amount

filter[amount_max]
number

Filter by maximum amount

include
enum<string>

Include related resources

Available options:
order,
user
sort
enum<string>

Sort by field

Available options:
created_at,
-created_at,
amount,
-amount,
status,
-status,
type,
-type

Response

200 - application/json

List of transactions

success
boolean
Example:

true

data
object[]
meta
object