Skip to main content
curl --request GET 'https://api.mayar.id/hl/v2/payments?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'
{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "6f8c19ff-5b97-4792-aa89-d2a12797b356",
            "amount": 100000,
            "category": null,
            "createdAt": 1768375011056,
            "description": "Pembayaran jasa konsultasi",
            "link": "rqp9x2k7m3a",
            "type": "payment_request",
            "status": "unpaid",
            "name": "Penagihan",
            "limit": null,
            "redirectUrl": null,
            "installmentId": null,
            "event": null,
            "order": null,
            "coverImageId": null,
            "multipleImageId": null,
            "transactions": [],
            "coverImage": null,
            "multipleImage": null
        },
        {
            "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "amount": 50000,
            "category": null,
            "createdAt": 1768288611042,
            "description": "Tagihan layanan bulanan",
            "link": "rqp4t8n1b6c",
            "type": "payment_request",
            "status": "paid",
            "name": "Tagihan Layanan",
            "limit": null,
            "redirectUrl": null,
            "installmentId": null,
            "event": null,
            "order": null,
            "coverImageId": null,
            "multipleImageId": null,
            "transactions": [
                {
                    "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                    "extraData": null
                }
            ],
            "coverImage": null,
            "multipleImage": null
        }
    ],
    "hasMore": true,
    "nextStartingAfter": "1768288611042"
}
Endpoint:
https://api.mayar.id/hl/v2/payments

Authorization

Authorization
string
required
Example:Authorization | Bearer Paste-Your-API-Key-Here

Query Parameters

status
string
Filter the list by payment request status (e.g. unpaid, paid, closed).
limit
integer
default:"10"
Number of items to return per page. Defaults to 10, with a maximum of 50.
startingAfter
string
Cursor for forward pagination. Pass the nextStartingAfter value from the previous response (a Unix timestamp in milliseconds, as a string) to fetch the next page.

Response

Successful Response

Main Structure (Root)

statusCode
integer
Status code form API.
messages
string
Status message that describes the status code.
data
array of object
List of single payment requests displayed.
hasMore
boolean
Information on whether there is additional data to be retrieved (true/false).
nextStartingAfter
string | null
Cursor to pass as startingAfter to fetch the next page. null when there is no further data.

data Structure (Array Of Object)

id
string<uuid>
Unique request payment ID.
amount
integer | null
Payment request price or nominal value.
category
string | null
Category, can be null if there is no category.
createdAt
number
Creation time in epoch milliseconds format.
description
string
Payment request description.
Payment request slug/short URL.
type
string
Product type. Always payment_request for this endpoint.
status
string
Payment request status (e.g. unpaid, paid, closed).
name
string | null
Payment request name.
limit
number | null
Certain amount limit, can be null.
redirectUrl
string | null
Redirect destination URL, can be null.
installmentId
string | null
Installment ID if the payment request supports installments, can be null.
event
object | null
Related event data, can be null.
order
object | null
Related order data, can be null.
coverImageId
string | null
ID cover image, can be null.
multipleImageId
string | null
ID for multiple image group, can be null.
transactions
array of object
List of related transactions (empty if none). Each item contains id and extraData.
coverImage
object | null
Cover image data, can be null.
multipleImage
array | null
List of additional images for the payment request.