Sort Payment Links by Type

Endpoint that returns active products of a given type

Request Example

curl --request POST 'https://api.mayar.id/hl/v2/payment-links/sort/generic_link' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

Response Example 200

{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "3d4a503a-04a7-4587-915a-8983f0ab05f7",
            "amount": 150000,
            "category": null,
            "createdAt": 1768375011056,
            "description": "<p>Jasa pembuatan website company profile.</p>\n",
            "link": "jasa-pembuatan-website",
            "type": "generic_link",
            "status": "active",
            "name": "Jasa Pembuatan Website",
            "limit": null,
            "redirectUrl": null,
            "installmentId": null,
            "event": null,
            "order": null,
            "coverImageId": "2529541f-dc98-4ca0-93bb-3c1d35a8dd07",
            "multipleImageId": null,
            "transactions": [],
            "coverImage": {
                "id": "2529541f-dc98-4ca0-93bb-3c1d35a8dd07",
                "fileType": "jpeg",
                "url": "https://media.mayar.id/images/2529541f-dc98-4ca0-93bb-3c1d35a8dd07.jpeg"
            },
            "multipleImage": null
        }
    ],
    "hasMore": true,
    "nextStartingAfter": "1768375011056"
}

Endpoint:

Production

https://api.mayar.id/hl/v2/payment-links/sort/{type}

https://api.mayar.club/hl/v2/payment-links/sort/{type}

Authorization

Authorization · string · required

Example:

Authorization | Bearer Paste-Your-API-Key-Here

Path Parameters

type · string · required

Product type whose active products you want to list (e.g. generic_link, event, webinar, digital_product).

Response

Successful Response

Main Structure (Root)

statusCode · integer

Status code from API.

messages · string

Status message that describes the status code.

data · array of object

List of active products of the requested type.

hasMore · boolean

Information on whether there is additional data to be retrieved (true/false).

nextStartingAfter · string | null

Cursor to pass for forward pagination. null when there is no further data.

data Structure (Array Of Object)

id · string

Unique identifier of the product.

amount · integer

Product price amount.

category · string | null

Product category if available.

createdAt · number

Timestamp in milliseconds indicating when the product was created.

description · string

Product description in HTML format.

link · string

Unique slug or identifier used in the product URL.

type · string

Product type.

status · string

Current product status (e.g., active, inactive).

name · string

Product name.

limit · integer | null

Purchase or access limit if configured.

redirectUrl · string | null

URL where the customer will be redirected after checkout.

installmentId · string | null

Installment identifier if the product supports installment payments.

event · object | null

Event details.

order · object | null

Order configuration if applicable.

coverImageId · string | null

Identifier of the cover image.

multipleImageId · string | null

Identifier list of additional images.

transactions · array

List of related transactions (empty if none).

coverImage · object | null

Cover image object containing image details.

multipleImage · array | null

List of additional image objects.