Get payments

Gets the list of the payments by the given filter.

get

Query parameters

AppIntegrationPaymentGatewayIdstringOptional

Filter by the app integration payment gateway id.

PriceIdstringOptional

The price id.

CodestringOptional

The payment request code.

UserIdstringOptional

The id of the user.

ReferralUserCodestringOptional

The reference user code.

Statusstring · enumOptional

The status of the payment request.

Possible values:

PaymentTypestringOptional

The payment request type.

CurrencyCodestringOptional

The currency code.

KeywordsstringOptional

The keywords to filter.

TestModebooleanOptional

The payment request amount.

CreatedDateFromstring · date-timeOptional

The created date from.

CreatedDateTostring · date-timeOptional

The created date to.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/payments HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "amountFee": 10,
        "status": "Completed",
        "notes": "Notes",
        "paymentType": "PaymentType",
        "invoiceNo": "INV-001",
        "description": "Description",
        "code": null,
        "name": null,
        "amountGross": 100,
        "id": "sApKpllz4sAplsmzha",
        "amountNet": 90,
        "commission": 10,
        "currencyCode": "USD",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[email protected]",
          "nickName": "example",
          "roles": [
            "admin",
            "support"
          ]
        },
        "price": {
          "id": "sApKpllz4sAplsmzha",
          "code": "Code",
          "name": "Name",
          "amount": 10,
          "currency": "USD",
          "description": "Description",
          "checkoutLink": "CheckoutLink",
          "tags": "Tags",
          "packageName": "PackageName",
          "packageId": "PackageId",
          "subscriptionName": "SubscriptionName",
          "subscriptionTypeId": "SubscriptionTypeId",
          "zOrder": 1
        },
        "package": {
          "id": "sApKpllz4sAplsmzha",
          "code": "CODE",
          "name": "NAME",
          "imageURL": "IMAGE",
          "patternAvatarURL": "https://www.example.com/pattern.jpg",
          "styles": "{\"color\": \"red\"}",
          "description": "DESCRIPTION",
          "tags": "TAGS",
          "isFree": true,
          "zOrder": 1,
          "features": [
            {
              "title": "Feature Title",
              "unit": "Unit",
              "quantity": 10,
              "isUnlimited": false,
              "id": "sApKpllz4sAplsmzha",
              "parentBrandId": "Brand_ID",
              "eventId": "Event_ID",
              "type": "Function",
              "code": "Code",
              "name": "Feature Name",
              "image": "https://www.example.com/image.jpg",
              "styles": "{\"color\": \"red\"}",
              "description": "Feature Description",
              "tags": "#Tag1, #Tag2",
              "zOrder": 1,
              "status": "Active"
            }
          ],
          "prices": [
            {
              "id": "sApKpllz4sAplsmzha",
              "code": "Code",
              "name": "Name",
              "amount": 10,
              "currency": "USD",
              "description": "Description",
              "checkoutLink": "CheckoutLink",
              "tags": "Tags",
              "packageName": "PackageName",
              "packageId": "PackageId",
              "subscriptionName": "SubscriptionName",
              "subscriptionTypeId": "SubscriptionTypeId",
              "zOrder": 1
            }
          ],
          "isDefault": true
        },
        "sharedAmount": 10,
        "amount": 100,
        "paymentDate": "2025-06-23T13:56:00.6372081+07:00",
        "createdDate": "2025-06-23T13:56:00.6372074+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}