Payments List

Payments List

Query Parameters

q Q
order Order
state PaymentState[]

Possible values: [PENDING, PAID, REFUNDED, FAILED]

payment_date_from date
payment_date_to date
create_date_from date
create_date_to date
update_date_from date
update_date_to date
limit Limit

Possible values: >= 1

Default value: 100

offset Offset

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

items object[]
Array [
id Id required
donation_id Donation Id required
state PaymentState required
Possible values: [PENDING, PAID, REFUNDED, FAILED]
An enumeration.
amount Amount required
payment_date date-time
payment_method object
id Id required
create_date date-time required
update_date date-time required
processor Processor required
label Label required
stripe_intent_id Stripe Intent Id
create_date date-time required
update_date date-time required
]
count Count required

{
  "items": [
    {
      "id": 0,
      "donation_id": 0,
      "state": "PENDING",
      "amount": 0,
      "payment_date": "2024-10-10T15:54:20.331Z",
      "payment_method": {
        "id": 0,
        "create_date": "2024-10-10T15:54:20.331Z",
        "update_date": "2024-10-10T15:54:20.331Z",
        "processor": "string",
        "label": "string"
      },
      "stripe_intent_id": "string",
      "create_date": "2024-10-10T15:54:20.331Z",
      "update_date": "2024-10-10T15:54:20.331Z"
    }
  ],
  "count": 0
}

GET /admin/api/v1/payments/

Authorization

name: IsAuthenticatedtype: httpscheme: bearer

Request

Bearer Token

q — query

order — query

state — query

PENDINGPAIDREFUNDEDFAILED

payment_date_from — query

payment_date_to — query

create_date_from — query

create_date_to — query

update_date_from — query

update_date_to — query

limit — query

offset — query

curl / cURL

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

python / requests

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

go / native

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

nodejs / axios

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

ruby / Net::HTTP

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

csharp / RestSharp

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

php / cURL

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

java / OkHttp

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

powershell / RestMethod

curl -L -X GET 'https://dev.riseact.org/admin/api/v1/payments/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'