GET
/
v1
/
payments
/
List project payments
curl --request GET \
  --url https://api.withconvexity.com/v1/payments/ \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Payments retrieved successfully",
  "data": {
    "items": [
      {
        "id": "2f6c9b14-3e8a-4d2f-9c11-7a5d0e8b1c23",
        "purpose": "WALLET_TOPUP",
        "status": "SUCCESS",
        "amount": 1500,
        "currency": "NGN",
        "paymentRef": "kpy_ref_9d4f2a7c1e8b",
        "subscriptionId": null,
        "projectId": "proj_3c1a9f0b",
        "planId": null,
        "billingCycle": null,
        "businessId": "10427",
        "providerId": "a1b2c3d4-e5f6-4711-8899-0a1b2c3d4e5f",
        "reference": "kpy_ref_9d4f2a7c1e8b",
        "amountUsd": "0.952300",
        "description": "Wallet balance top-up",
        "createdBy": "system",
        "createdAt": "2026-06-15T09:42:17.512Z",
        "updatedAt": "2026-06-15T09:42:18.004Z"
      },
      {
        "id": "7b0e2d55-1a44-49c8-b2e1-3f6c8a9d0e12",
        "purpose": "WALLET_TOPUP",
        "status": "SUCCESS",
        "amount": 5000,
        "currency": "NGN",
        "paymentRef": "kpy_ref_4c8e1b9a2f7d",
        "subscriptionId": null,
        "projectId": "proj_3c1a9f0b",
        "planId": null,
        "billingCycle": null,
        "businessId": "10427",
        "providerId": "a1b2c3d4-e5f6-4711-8899-0a1b2c3d4e5f",
        "reference": "kpy_ref_4c8e1b9a2f7d",
        "amountUsd": "3.174300",
        "description": "Wallet balance top-up",
        "createdBy": "system",
        "createdAt": "2026-06-14T18:03:55.221Z",
        "updatedAt": "2026-06-14T18:03:55.880Z"
      }
    ],
    "total": 2,
    "page": 1,
    "pageSize": 20
  }
}

Authorizations

Authorization
string
header
required

OAuth 2.0 access token from Auth-Edge.

Query Parameters

page
integer
default:1

Page number.

pageSize
integer
default:20

Items per page (max 100).

purpose
enum<string>

Filter by payment purpose.

Available options:
SUBSCRIPTION,
WALLET_TOPUP
status
enum<string>

Filter by payment status.

Available options:
PENDING,
SUCCESS,
FAILED,
REFUNDED
subscriptionId
string

Filter by subscription id.

Response

OK

The response is of type object.