Mayar

https://docs.mayar.id
Admin
Mayar is a simple and powerful platform that helps businesses sell products and accept payments...
Tokens:232,446
Snippets:1,952
Trust Score:8.4
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET bundling detail - 200 response example

Source: https://docs.mayar.id/api-reference-v2/bundling/detail

Example JSON response returned when the bundling is found. Contains bundling metadata, user/account info, and a list of products with their payment links.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
        "name": "Paket Belajar Lengkap",
        "amount": 150000,
        "description": "<p>Paket bundling kelas online dan produk digital.</p>\n",
        "type": "bundling",
        "status": "active",
        "link": "paket-belajar-lengkap",
        "updatedAt": 1782557015266,
        "createdAt": 1773826841895,
        "subType": null,
        "tax": null,
        "items": null,
        "limit": null,
        "expiredAt": null,
        "redirectUrl": "",
        "notes": "Catatan internal paket bundling.",
        "terms": null,
        "target": null,
        "reason": null,
        "receiver": null,
        "usage": null,
        "category": null,
        "affiliateCommission": null,
        "paymentType": null,
        "qty": null,
        "bundlingProductType": "payment_link",
        "coverImageId": null,
        "multipleImageId": null,
        "customerId": null,
        "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
        "event": null,
        "coverImage": null,
        "multipleImage": null,
        "customer": null,
        "user": {
            "id": "348e083d-315a-4e5c-96b1-5a2a98c48413",
            "accountId": "d4e5f6a7-b8c9-4012-d345-6789abcdef01",
            "account": {
                "id": "d4e5f6a7-b8c9-4012-d345-6789abcdef01",
                "name": "Mayar Demo Account"
            }
        },
        "products": [
            {
                "id": "6f8c19ff-2b6a-4c7e-9f1d-1a2b3c4d5e6f",
                "status": "ENABLED",
                "variantId": null,
                "updatedAt": 1773826843750,
                "paymentLinkId": "21d84338-7c2e-4a9b-8d3f-4e5f6a7b8c9d",
                "paymentLink": {
                    "id": "21d84338-7c2e-4a9b-8d3f-4e5f6a7b8c9d",
                    "name": "Kelas Online Dasar",
                    "type": "course",
                    "amount": 0,
                    "variant": null
                }
            },
            {
                "id": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
                "status": "ENABLED",
                "variantId": null,
                "updatedAt": 1773826843750,
                "paymentLinkId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
                "paymentLink": {
                    "id": "348e083d-315a-4e5c-96b1-5a2a98c48413",
                    "name": "Produk Digital Premium",
                    "type": "digital_product",
                    "amount": 100000,
                    "variant": null
                }
            }
        ]
    }
}

```

--------------------------------

### GET Product Detail - Response Example 200

Source: https://docs.mayar.id/api-reference-v2/product/detail

Example JSON response for a successful product detail request. Shows the full product object including id, name, amount, status, and URLs.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "6f8c19ff-5b97-4792-aa89-d2a12797b356",
        "link": "jasa-pembuatan-website",
        "name": "Jasa Pembuatan Website",
        "category": null,
        "limit": null,
        "type": "generic_link",
        "subType": null,
        "variant": null,
        "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
        "membershipTier": [],
        "event": null,
        "order": null,
        "qty": null,
        "amount": 150000,
        "status": "active",
        "description": "<p>Jasa pembuatan website company profile.</p>\n",
        "coverImageId": "2529541f-dc98-4ca0-93bb-3c1d35a8dd07",
        "multipleImageId": null,
        "transactions": [
            {
                "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
                "extraData": null
            }
        ],
        "multipleImage": null,
        "coverImage": {
            "id": "2529541f-dc98-4ca0-93bb-3c1d35a8dd07",
            "fileType": "jpeg",
            "url": "https://media.mayar.id/images/2529541f-dc98-4ca0-93bb-3c1d35a8dd07.jpeg"
        },
        "linkUrl": "https://testingmayar.myr.id/plink/jasa-pembuatan-website",
        "linkPayment": "https://testingmayar.myr.id/pl/jasa-pembuatan-website"
    }
}

```

--------------------------------

### GET /hl/v2/installments - Response Example 200

Source: https://docs.mayar.id/api-reference-v2/installment

Example successful response showing the structure of the returned data, including installment details and pagination fields.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
            "amount": 1500000,
            "category": null,
            "createdAt": 1768375011056,
            "description": "Cicil Produk Kelas Online 3 Bulan",
            "link": "mkcn4u72ki",
            "type": "installment",
            "status": "unpaid",
            "name": "Budi Santoso",
            "limit": null,
            "redirectUrl": null,
            "installmentId": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
            "event": null,
            "order": null,
            "coverImage": null,
            "multipleImage": [],
            "transactions": []
        }
    ],
    "hasMore": false,
    "nextStartingAfter": null
}

```

--------------------------------

### GET /hl/v2/coupons Request Example

Source: https://docs.mayar.id/api-reference-v2/discount

Example curl command to fetch a list of coupons with a limit of 10. Requires an Authorization header with a Bearer API key.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/coupons?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### GET product reviews - 200 response example

Source: https://docs.mayar.id/api-reference-v2/reviews/productreviews

Example JSON response for a successful request. Shows the structure of the returned review objects, including customer and payment link details.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "11f4d767-4d88-41ff-8777-06564d906fe7",
            "createdAt": 1767063610103,
            "customerId": "22eb6224-c20a-4bc2-9b99-13b21e7048c6",
            "message": "Materinya jelas dan mudah dipahami, terima kasih!",
            "paymentLinkId": "e2b3f5d5-0c62-47ba-8a01-6c1c209e0f77",
            "status": "ACTIVE",
            "rating": 5,
            "updatedAt": 1767762378460,
            "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
            "multipleImage": [],
            "content": [
                {
                    "id": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
                    "value": "c3d4e5f6-a7b8-4901-c234-56789abcdef0",
                    "file": {
                        "id": "c3d4e5f6-a7b8-4901-c234-56789abcdef0",
                        "filename": "ulasan-video.mp4",
                        "mimetype": "video/mp4",
                        "size": 5698168
                    }
                }
            ],
            "customer": {
                "id": "22eb6224-c20a-4bc2-9b99-13b21e7048c6",
                "name": "Budi Santoso"
            },
            "paymentLink": {
                "id": "e2b3f5d5-0c62-47ba-8a01-6c1c209e0f77",
                "name": "Kelas Pemrograman Web Dasar",
                "type": "course",
                "link": "kelas-pemrograman-web-dasar",
                "subType": null
            }
        }
    ],
    "hasMore": false,
    "nextStartingAfter": null
}

```

--------------------------------

### Request Example: GET /hl/v2/balances

Source: https://docs.mayar.id/api-reference-v2/balance/accountbalance

Use this curl command to retrieve the account balance. Replace 'Paste-Your-API-Key-Here' with your actual API key.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/balances' \
 --header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### Bundling list response example (200)

Source: https://docs.mayar.id/api-reference-v2/bundling

Example of a successful response from the bundling endpoint. It includes a list of bundling products with details such as id, name, amount, description, type, status, link, timestamps, and an array of products with their payment links.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
            "name": "Paket Belajar Lengkap",
            "amount": 150000,
            "description": "<p>Paket bundling kelas online dan produk digital.</p>\n",
            "type": "bundling",
            "status": "active",
            "link": "paket-belajar-lengkap",
            "updatedAt": 1782557015266,
            "createdAt": 1773826841895,
            "bundlingProductType": "payment_link",
            "coverImageId": null,
            "coverImage": null,
            "products": [
                {
                    "id": "6f8c19ff-2b6a-4c7e-9f1d-1a2b3c4d5e6f",
                    "status": "ENABLED",
                    "paymentLinkId": "21d84338-7c2e-4a9b-8d3f-4e5f6a7b8c9d",
                    "paymentLink": {
                        "id": "21d84338-7c2e-4a9b-8d3f-4e5f6a7b8c9d",
                        "name": "Kelas Online Dasar",
                        "type": "course",
                        "amount": 0
                    }
                },
                {
                    "id": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
                    "status": "ENABLED",
                    "paymentLinkId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
                    "paymentLink": {
                        "id": "348e083d-315a-4e5c-96b1-5a2a98c48413",
                        "name": "Produk Digital Premium",
                        "type": "digital_product",
                        "amount": 100000
                    }
                },
                {
                    "id": "c3d4e5f6-a7b8-4901-c234-56789abcdef0",
                    "status": "ENABLED",
                    "paymentLinkId": "7c9d2e1f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
                    "paymentLink": {
                        "id": "7c9d2e1f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
                        "name": "Link Pembayaran Tambahan",
                        "type": "generic_link",
                        "amount": 50000
                    }
                }
            ]
        }
    ],
    "hasMore": false,
    "nextStartingAfter": null
}

```

--------------------------------

### Request Example: GET installment detail with curl

Source: https://docs.mayar.id/api-reference-v2/installment/detail

Use this curl command to fetch installment details. Replace 'Paste-Your-API-Key-Here' with your actual API key. The uuId in the URL is the installment's unique identifier.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/installments/ba82c2dd-06c1-4b6c-bc59-a9c00801c842' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### GET /hl/v2/installments - Request Example

Source: https://docs.mayar.id/api-reference-v2/installment

Fetches a list of installments with a limit of 10. Requires an Authorization header with a Bearer API key.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/installments?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### Get Installments

Source: https://docs.mayar.id/llms.txt

Endpoint to get a list of installments.

```APIDOC
## Get Installments

### Description
Endpoint to get a list of installments.

### Endpoint
Refer to the original documentation for the full endpoint path and method.
```

--------------------------------

### Add Credit Request Example (cURL)

Source: https://docs.mayar.id/api-reference-v2/credit/add-credit

Example cURL command to add credit to a customer's wallet. Requires an API key and the customer and product IDs.

```bash
curl --request POST 'https://api.mayar.id/credit/v2/credit/customer/add-credit' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
    "productId": "7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
    "amount": 50000
}'
```

--------------------------------

### Get Installment Detail

Source: https://docs.mayar.id/llms.txt

Endpoint to view details and status of an installment.

```APIDOC
## GET /installment/{id}

### Description
Endpoint used to view details and status of installment that have been created.

### Method
GET

### Endpoint
/installment/{id}
```

--------------------------------

### Response Example 200 (Credit Usage Product)

Source: https://docs.mayar.id/api-reference-v2/credit/balance

Example successful response for a credit-usage product. The data object contains customerBalance, customerBalanceMain, and customerBalanceAddon fields.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "customerBalance": 50000,
        "customerBalanceMain": 50000,
        "customerBalanceAddon": 0
    }
}

```

--------------------------------

### Create Digital Product - Request Example (cURL)

Source: https://docs.mayar.id/api-reference-v2/digitalproduct/create

cURL command to create a digital product. Requires an API key in the Authorization header. The request body includes product details such as name, description, amount, crossoutPrice, redirectUrl, notes, expiredAt, limit, and tax.

```bash
curl --request POST 'https://api.mayar.id/hl/v2/products/digital-product/create' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--data-raw '{
        "name": "E-Book Panduan Bisnis Buat Pemula",
        "description": "Panduan lengkap memulai bisnis online",
        "amount": 75000,
        "crossoutPrice": 150000,
        "redirectUrl": "https://example.com/ebook-download",
        "notes": "diskon-50",
        "expiredAt": "2026-06-15T12:00:00.000Z",
        "limit": 200,
        "tax": 7500
    }'
```

--------------------------------

### Get Installment Detail

Source: https://docs.mayar.id/llms.txt

Endpoint used to view details and status of an installment that has been created.

```APIDOC
## Get Installment Detail

### Description
Endpoint used to view details and status of an installment that has been created.

### Endpoint
Refer to the original documentation for the full endpoint path and method.
```

--------------------------------

### Add Credit Response Example (200)

Source: https://docs.mayar.id/api-reference-v2/credit/add-credit

Example successful response showing the customer's new balance after the top-up.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "customerNewBalance": 150000
    }
}
```

--------------------------------

### GET /hl/v2/installments

Source: https://docs.mayar.id/api-reference-v2/migration-from-v1

Lists installments in V2.

```APIDOC
## GET /hl/v2/installments

### Description
Lists installments in V2.

### Method
GET

### Endpoint
/hl/v2/installments

```

--------------------------------

### Get Static QRIS - Request Example

Source: https://docs.mayar.id/api-reference-v2/qrcode/getstaticqrcode

Sends a GET request to the static QRIS endpoint. Requires an Authorization header with a valid API key.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/qr-codes/static' \
 --header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### 200 response example for discount detail

Source: https://docs.mayar.id/api-reference-v2/discount/detail

Example successful response showing the discount and its associated coupon data.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "c9aa143a-53f9-44e7-a9c6-83229ad7199b",
        "createdAt": 1755665561029,
        "expiredAt": 1893488774933,
        "productDiscount": [],
        "discountType": "monetary",
        "discountProductType": "all",
        "eligibleCustomerType": "all",
        "name": "Diskon Murmer",
        "minimumPurchase": 500000,
        "isLifeTime": null,
        "totalCoupons": 100,
        "value": 100000,
        "coupons": [
            {
                "id": "532858fe-3722-4cf4-a8eb-f7c6765aba17",
                "code": "haribaik",
                "createdAt": 1755665561256,
                "discountId": "c9aa143a-53f9-44e7-a9c6-83229ad7199b",
                "endMonthTrial": null,
                "expiredAt": 1893488774933,
                "isActive": true,
                "limit": 100,
                "type": "reusable",
                "updatedAt": 1755665561256,
                "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413"
            }
        ]
    }
}
```

--------------------------------

### Create Installment - 200 Response

Source: https://docs.mayar.id/api-reference-v2/installment/create

Example successful response with statusCode 200, containing installment details, customer info, and generated invoices with payment URLs.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
        "amount": 1500000,
        "interest": 0,
        "interestType": "FLAT",
        "period": "MONTHLY",
        "tenure": 3,
        "dueDate": 11,
        "totalInterest": 0,
        "totalAmount": 1500000,
        "description": "Cicil Produk Kelas Online 3 Bulan",
        "customer": {
            "email": "budi.santoso@example.com",
            "name": "Budi Santoso",
            "mobile": "081234567890"
        },
        "status": "unpaid",
        "invoices": [
            {
                "id": "9fe1b9c4-b5d5-4d45-bf1a-5c4849631725",
                "index": 1,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 1000000,
                "dueDate": "2026-07-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "mkcn4u72ki",
                "paymentUrl": "https://yourstore.myr.id/invoices/mkcn4u72ki"
            },
            {
                "id": "977777d6-af25-464e-a8ca-e290b3007275",
                "index": 2,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 500000,
                "dueDate": "2026-08-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "0ll429zxvsue",
                "paymentUrl": "https://yourstore.myr.id/invoices/0ll429zxvsue"
            },
            {
                "id": "1dde3426-f6a4-43d2-a1d9-2cd2fa05eb9a",
                "index": 3,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 0,
                "dueDate": "2026-09-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "h8fiobqkek",
                "paymentUrl": "https://yourstore.myr.id/invoices/h8fiobqkek"
            }
        ],
        "createdAt": "2026-06-19T17:20:09.521Z"
    }
}
```

--------------------------------

### Response Example 200 - List Payment Requests

Source: https://docs.mayar.id/api-reference-v2/reqpayment

Example successful response from the GET /hl/v2/payments endpoint. Shows the structure with statusCode, messages, data array, hasMore, and nextStartingAfter fields.

```json
{
    "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"
}

```

--------------------------------

### Register Membership - Request Example (curl)

Source: https://docs.mayar.id/api-reference-v2/membership/register

Use this curl command to register a new membership customer. Replace the Authorization header with your API key and provide the required productId, membershipTierId, customerInfo, and membershipMonthlyPeriod.

```bash
curl --request POST 'https://api.mayar.id/hl/v2/memberships/members/create' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productId": "7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
    "membershipTierId": "9b2d4f6a-8c1e-4a3b-bd5c-6e7f8a9b0c1d",
    "customerInfo": {
        "name": "Budi Santoso",
        "email": "budi.santoso@example.com",
        "mobile": "081234567890"
    },
    "membershipMonthlyPeriod": 1
}'
```

--------------------------------

### Register Membership - Response Example 201

Source: https://docs.mayar.id/api-reference-v2/membership/register

Successful registration returns HTTP 201 with a membershipCustomer object containing the new member's details, including memberId, status, and payment schedule.

```json
{
    "statusCode": 201,
    "message": "success",
    "data": {
        "membershipCustomer": {
            "id": "c4d5e6f7-a8b9-4c0d-8e1f-2a3b4c5d6e7f",
            "memberId": "MBR8X2QK",
            "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
            "customerId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
            "membershipTierId": "9b2d4f6a-8c1e-4a3b-bd5c-6e7f8a9b0c1d",
            "paymentLinkId": "7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
            "monthlyPaymentPeriod": 1,
            "status": "active",
            "nextPayment": "2026-07-20T09:10:57.994Z",
            "expiredAt": null,
            "createdAt": "2026-06-20T09:10:57.994Z",
            "updatedAt": "2026-06-20T09:10:57.994Z"
        }
    }
}
```

--------------------------------

### cURL Request Example

Source: https://docs.mayar.id/api-reference-v2/customer/getdetail

Example cURL command to fetch a list of customers with a limit of 10. Requires an API key in the Authorization header.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/customers?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### Create Discount Coupon - Request Example (curl)

Source: https://docs.mayar.id/api-reference-v2/discount/create

Use this curl command to create a discount coupon. It requires an API key in the Authorization header. The request body includes coupon details such as name, expiry, discount type, eligible customer type, minimum purchase, value, total coupons, coupon code and type, and products.

```bash
curl --request POST 'https://api.mayar.id/hl/v2/coupons/create' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--data-raw '{
    "name": "Diskon Murmer",
    "expiredAt": "2030-01-01T09:06:14.933Z",
    "discount": {
        "discountType": "monetary",
        "eligibleCustomerType": "all",
        "minimumPurchase": 500000,
        "value": 100000,
        "totalCoupons": 100
    },
    "coupon": {
        "code": "haribaik",
        "type": "reusable"
    },
    "products": []
}
'
```

--------------------------------

### Get Static QRIS - Response Example 500

Source: https://docs.mayar.id/api-reference-v2/qrcode/getstaticqrcode

Error response returned when the merchant has no static QRIS configured.

```json
{
    "statusCode": 500,
    "messages": "Invalid data"
}

```

--------------------------------

### Create Generic Link - Response Example 200

Source: https://docs.mayar.id/api-reference-v2/genericlink/create

Shows a successful response with statusCode 200, a success message, and the created product data including its unique id and public link.

```json
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "21d84338-b46d-42d7-9b49-d402520407a5",
        "link": "https://testingmayar.myr.id/pl/Jasa-Buat-Website-Kece"
    }
}
```

--------------------------------

### Fetch bundling list with curl

Source: https://docs.mayar.id/api-reference-v2/bundling

Use this curl command to retrieve a list of bundling products. Replace 'Paste-Your-API-Key-Here' with your actual API key. The endpoint returns a JSON response with a list of bundling items.

```bash
curl --request GET 'https://api.mayar.id/hl/v2/bundling?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'

```

--------------------------------

### GET /hl/v2/installments/{uuId}

Source: https://docs.mayar.id/api-reference-v2/installment/detail

Fetches the details of a specific installment by its UUID. The response includes installment-level information and a list of invoices.

```APIDOC
## GET /hl/v2/installments/{uuId}

### Description
Retrieves detailed information about a specific installment using its unique identifier.

### Method
GET

### Endpoint
`https://api.mayar.id/hl/v2/installments/{uuId}`

### Parameters
#### Path Parameters
- **uuId** (string) - Required - A unique identifier obtained when creating an installment. If accessed through the dashboard, it can be found in the URL on the installment details page. Example: `ba82c2dd-06c1-4b6c-bc59-a9c00801c842`

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication. Example: `Authorization: Bearer Paste-Your-API-Key-Here`

### Request Example
```
curl --request GET 'https://api.mayar.id/hl/v2/installments/ba82c2dd-06c1-4b6c-bc59-a9c00801c842' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'
```

### Response
#### Success Response (200)
- **statusCode** (integer) - Status code from API.
- **messages** (string) - Status message that describes the status code.
- **data** (object) - The installment detail object.
  - **id** (string<uuid>) - Main installment ID.
  - **amount** (integer) - Total installment amount.
  - **interest** (integer) - Interest value.
  - **interestType** (string) - Type of interest (example: `"FLAT"`).
  - **period** (string) - Installment period (example: `"MONTHLY"`).
  - **tenure** (integer) - Installment duration (in months).
  - **dueDate** (integer) - Due date each month (example: `11`).
  - **totalInterest** (integer) - Total interest across all installments.
  - **totalAmount** (integer) - Total amount payable across all installments.
  - **description** (string) - Installment description.
  - **customer** (object) - Customer details.
    - **name** (string) - Customer name.
    - **email** (string) - Customer email address.
    - **mobile** (string) - Customer phone number.
  - **status** (string) - Installment status (example: `"unpaid"`).
  - **invoices** (array of object) - List of installment invoices.
    - **id** (string<uuid>) - Invoice ID.
    - **index** (integer) - Invoice order number.
    - **amount** (integer) - Invoice amount.
    - **interestAmount** (integer) - Interest amount for the invoice.
    - **remainingAmount** (integer) - Remaining balance after this invoice.
    - **dueDate** (string (ISO 8601)) - Invoice due date in ISO 8601 format.
    - **status** (string) - Payment status (example: `"unpaid"`).
    - **link** (string) - Unique invoice link.
  - **createdAt** (string (ISO 8601)) - Creation time in ISO 8601 format.

#### Response Example
```
{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
        "amount": 1500000,
        "interest": 0,
        "interestType": "FLAT",
        "period": "MONTHLY",
        "tenure": 3,
        "dueDate": 11,
        "totalInterest": 0,
        "totalAmount": 1500000,
        "description": "Cicil Produk Kelas Online 3 Bulan",
        "customer": {
            "name": "Budi Santoso",
            "email": "budi.santoso@example.com",
            "mobile": "081234567890"
        },
        "status": "unpaid",
        "invoices": [
            {
                "id": "9fe1b9c4-b5d5-4d45-bf1a-5c4849631725",
                "index": 1,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 1000000,
                "dueDate": "2026-07-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "mkcn4u72ki"
            },
            {
                "id": "977777d6-af25-464e-a8ca-e290b3007275",
                "index": 2,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 500000,
                "dueDate": "2026-08-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "0ll429zxvsue"
            },
            {
                "id": "1dde3426-f6a4-43d2-a1d9-2cd2fa05eb9a",
                "index": 3,
                "amount": 500000,
                "interestAmount": 0,
                "remainingAmount": 0,
                "dueDate": "2026-09-11T00:00:00.000Z",
                "status": "unpaid",
                "link": "h8fiobqkek"
            }
        ],
        "createdAt": "2026-06-19T17:20:09.521Z"
    }
}
```

### Errors
#### 401 Unauthorized
Returned with `messages: "Unauthorized"` when the installment does not belong to the authenticated account.
```

--------------------------------

### Spend Credit Request Example (curl)

Source: https://docs.mayar.id/api-reference-v2/credit/spend

Example curl command to spend credit for a customer. Requires an API key in the Authorization header and a JSON body with customerId, productId, and amount.

```bash
curl --request POST 'https://api.mayar.id/credit/v2/credit/customer/spend' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customerId": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
    "productId": "7c9d2e1f-4a5b-4c6d-8e9f-0a1b2c3d4e5f",
    "amount": 10000
}'

```

--------------------------------

### GET Product Transactions - Response Example 200

Source: https://docs.mayar.id/api-reference-v2/product/transactions

Example JSON response with statusCode 200. The 'total' field indicates the number of successful transactions, and each item includes balance history details such as 'credit', 'amount', 'status', and fee breakdowns.

```json
{
    "statusCode": 200,
    "messages": "success",
    "total": 1,
    "data": [
        {
            "id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
            "transactionId": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
            "credit": 150000,
            "amount": 150000,
            "status": "settled",
            "balanceHistoryType": "membership",
            "paymentMethod": "QRIS",
            "customerId": "c3d4e5f6-a7b8-4901-c234-56789abcdef0",
            "createdAt": 1768375011056,
            "paymentLinkTransactionId": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
            "fee": [
                {
                    "id": "d4e5f6a7-b8c9-4012-d345-6789abcdef01",
                    "balanceHistoryType": "xendit_fee",
                    "debit": 6
                },
                {
                    "id": "e5f6a7b8-c9d0-4123-e456-789abcdef012",
                    "balanceHistoryType": "mayar_fee",
                    "debit": 53
                }
            ],
            "paymentLinkId": "6f8c19ff-5b97-4792-aa89-d2a12797b356",
            "subscriptionId": null,
            "xenditTransactionId": null,
            "subscription": null,
            "paymentLinkTransaction": {
                "id": "b2c3d4e5-f6a7-4890-b123-456789abcdef",
                "urlParamTrackingData": null,
                "isAdminFeeBorneByCustomer": true,
                "isChannelFeeBorneByCustomer": true
            },
            "customeField": null,
            "customer": {
                "id": "c3d4e5f6-a7b8-4901-c234-56789abcdef0",
                "name": "Budi Santoso",
                "email": "budi.santoso@example.com",
                "mobile": "081234567890"
            },
            "paymentLink": {
                "id": "6f8c19ff-5b97-4792-aa89-d2a12797b356",
                "name": "Membership Premium 2026"
            },
            "xenditTransaction": null
        }
    ],
    "hasMore": false,
    "nextStartingAfter": null
}

```

--------------------------------

### GET /hl/v2/installments

Source: https://docs.mayar.id/api-reference-v2/installment

Fetches a list of installment payment links. Supports filtering by status and customer ID, and pagination via cursor.

```APIDOC
## GET /hl/v2/installments

### Description
Retrieves a paginated list of installment payment links. Supports filtering by status and customer ID, and cursor-based pagination.

### Method
GET

### Endpoint
`https://api.mayar.id/hl/v2/installments` (Production)
`https://api.mayar.io/hl/v2/installments` (Sandbox)

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter the list by installment status (e.g. `unpaid`, `active`).
- **customerId** (string) - Optional - Filter installments by a specific customer ID.
- **limit** (integer) - Optional - Number of items to return per page. Defaults to `10`, with a maximum of `50`.
- **startingAfter** (string) - Optional - 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.

### Request Example
```
curl --request GET 'https://api.mayar.id/hl/v2/installments?limit=10' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here'
```

### Response
#### Success Response (200)
- **statusCode** (integer) - Status code from API.
- **messages** (string) - Status message that describes the status code.
- **data** (array of object) - List of installments. Each item is an installment-type payment-link object.
- **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 ID of the installment.
- **amount** (integer) - Total installment amount.
- **category** (string | null) - Item category (if any).
- **createdAt** (number (timestamp)) - Creation time in epoch format (ms).
- **description** (string) - Installment description.
- **link** (string) - Unique link slug.
- **type** (string) - Item type. Always `installment` for this list.
- **status** (string) - Installment status (example: `unpaid`).
- **name** (string) - Name associated with the installment.
- **limit** (integer | null) - Stock/quantity limit (if any).
- **redirectUrl** (string | null) - Redirect URL after payment (if any).
- **installmentId** (string<uuid>) - Associated installment record ID.
- **event** (object | null) - Event details (not applicable to installments).
- **order** (object | null) - Order/shipping details (if any).
- **coverImage** (object | null) - Cover image details (if any).
- **multipleImage** (array of object) - Additional images (if any).
- **transactions** (array of object) - Related transactions (if any).

#### Response Example
```
{
    "statusCode": 200,
    "messages": "success",
    "data": [
        {
            "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
            "amount": 1500000,
            "category": null,
            "createdAt": 1768375011056,
            "description": "Cicil Produk Kelas Online 3 Bulan",
            "link": "mkcn4u72ki",
            "type": "installment",
            "status": "unpaid",
            "name": "Budi Santoso",
            "limit": null,
            "redirectUrl": null,
            "installmentId": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
            "event": null,
            "order": null,
            "coverImage": null,
            "multipleImage": [],
            "transactions": []
        }
    ],
    "hasMore": false,
    "nextStartingAfter": null
}
```

```
Tokens:
Raw