Get a payment

Get a payment by the given id.

get

Path parameters

idstringRequired

The id of the payment.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

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

application/json

get

/api/v1/payments/{id}

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "amountNet": 90,
    "status": "Completed",
    "notes": "Notes",
    "paymentDate": "2026-01-26T08:03:23.850859+07:00",
    "paymentType": "PaymentType",
    "code": null,
    "name": null,
    "amountGross": 100,
    "amountFee": 10,
    "id": "sApKpllz4sAplsmzha",
    "commission": 10,
    "currencyCode": "USD",
    "description": "Description",
    "invoiceNo": "INV-001",
    "user": {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[e-mail]",
      "phoneNumber": "[phone]",
      "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,
      "tier": 0,
      "zOrder": 1,
      "features": [
        {
          "type": "Function",
          "title": "Feature Title",
          "value": 10,
          "isUnlimited": false,
          "resetPolicy": 0,
          "customIntervalDays": null,
          "id": "sApKpllz4sAplsmzha",
          "parentBrandId": "Brand_ID",
          "eventId": "Event_ID",
          "code": "Code",
          "name": "Feature Name",
          "unit": "Unit",
          "defaultValue": null,
          "helpURL": null,
          "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,
      "status": "Inactive"
    },
    "sharedAmount": 10,
    "amount": 100,
    "createdDate": "2026-01-26T08:03:23.850858+07:00"
  },
  "errors": []
}