Skip to main content
POST
/
api
/
admin
/
stripePayments
List payments
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/stripePayments \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "account": "<string>",
  "institution": "<string>",
  "usersearch": "<string>",
  "page": 1,
  "pageSize": 100,
  "limitsearch": 123
}
'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "user": {
        "_id": "<string>",
        "email": "<string>",
        "fname": "<string>",
        "lname": "<string>"
      },
      "institution": {
        "_id": "<string>",
        "name": "<string>"
      },
      "amount": 123,
      "currency": "<string>",
      "credits": 123,
      "plan": "<string>",
      "source": "<string>",
      "description": "<string>",
      "invoiceUrl": "<string>"
    }
  ],
  "total": 123,
  "hasMore": true,
  "page": 123,
  "pageSize": 123,
  "message": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
account
string

Account ID(s) to filter payments (space-separated for multiple)

institution
string

Institution ID to filter payments

usersearch
string

Search term for users (matches email, first name, last name)

page
integer
default:1

Page number (1-based)

Required range: x >= 1
pageSize
integer
default:100

Number of results per page

Required range: 1 <= x <= 5000
limitsearch
integer
deprecated

Legacy limit parameter (use pageSize instead)

Response

Successfully retrieved payments list

success
boolean

Request success status

data
object[]

Array of payment objects

total
integer

Total number of matching payments

hasMore
boolean

Whether more results are available

page
integer

Current page number

pageSize
integer

Number of results per page

message
string

Response message