APIList Payment Requests

List Payment Requests

Retrieve a paginated list of all payment requests for a project.

GET/v2/projects/{project_id}/payment-requests

Authorization

Bearer TokenRequired

Path Parameters

project_idstringRequired

The unique identifier of the project.

Query Parameters

limitinteger

Number of items per page. Default: 50

offsetinteger

Number of items to skip. Default: 0

Request
curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/payment-requests?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
Successapplication/json
{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/payment-requests",
  "code": 200,
  "total": 2,
  "message": "Payment requests fetched successfully",
  "data": [
    {
      "payment_request_id": "11111111-1111-1111-1111-111111111111",
      "merchant_account_id": "22222222-2222-2222-2222-222222222222",
      "amount": "29.99",
      "currency": "USD",
      "status": "completed",
      "request_type": "invoice",
      "created_at": "2024-12-14T10:30:00.000Z",
      "user_id": "123456789012345678",
      "provider": "stripe",
      "provider_payment_id": "pi_3NkQz2ABC123",
      "settled_at": "2024-12-14T10:35:00.000Z",
      "payment_request_data": {}
    },
    {
      "payment_request_id": "33333333-3333-3333-3333-333333333333",
      "merchant_account_id": "22222222-2222-2222-2222-222222222222",
      "amount": "49.99",
      "currency": "USD",
      "status": "pending",
      "request_type": "invoice",
      "created_at": "2024-12-15T08:00:00.000Z",
      "user_id": "987654321098765432",
      "provider": "stripe",
      "provider_payment_id": "pi_3NkQz2DEF456",
      "settled_at": null,
      "payment_request_data": {}
    }
  ]
}

Last updated: