Get Installment Detail

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

{
    "statusCode": 200,
    "messages": "Success",
    "data": {
        "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
        "createdAt": 1755631209521,
        "period": "MONTHLY",
        "tenure": 3,
        "dueDate": 11,
        "interest": 0,
        "interestType": "FLAT",
        "paymentLinkId": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
        "updatedAt": 1755631209521,
        "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
        "paymentLink": {
            "id": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
            "name": "Azumii",
            "amount": 1500000,
            "description": "Cicil Produk Kelas Online 3 Bulan",
            "customerId": "62d1a396-07d8-4d93-a14c-9ec801f3af20"
        },
        "invoices": [
            {
                "id": "9fe1b9c4-b5d5-4d45-bf1a-5c4849631725",
                "expiredAt": 1757523600000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 1,
                "link": "mkcn4u72ki",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 1000000
            },
            {
                "id": "977777d6-af25-464e-a8ca-e290b3007275",
                "expiredAt": 1760115600000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 2,
                "link": "0ll429zxvsue",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 500000
            },
            {
                "id": "1dde3426-f6a4-43d2-a1d9-2cd2fa05eb9a",
                "expiredAt": 1762794000000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 3,
                "link": "h8fiobqkek",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 0
            }
        ]
    }
}

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

{
    "statusCode": 200,
    "messages": "Success",
    "data": {
        "id": "ba82c2dd-06c1-4b6c-bc59-a9c00801c842",
        "createdAt": 1755631209521,
        "period": "MONTHLY",
        "tenure": 3,
        "dueDate": 11,
        "interest": 0,
        "interestType": "FLAT",
        "paymentLinkId": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
        "updatedAt": 1755631209521,
        "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
        "paymentLink": {
            "id": "8f722421-e8fd-4d05-ae0c-5f4a224b7923",
            "name": "Azumii",
            "amount": 1500000,
            "description": "Cicil Produk Kelas Online 3 Bulan",
            "customerId": "62d1a396-07d8-4d93-a14c-9ec801f3af20"
        },
        "invoices": [
            {
                "id": "9fe1b9c4-b5d5-4d45-bf1a-5c4849631725",
                "expiredAt": 1757523600000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 1,
                "link": "mkcn4u72ki",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 1000000
            },
            {
                "id": "977777d6-af25-464e-a8ca-e290b3007275",
                "expiredAt": 1760115600000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 2,
                "link": "0ll429zxvsue",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 500000
            },
            {
                "id": "1dde3426-f6a4-43d2-a1d9-2cd2fa05eb9a",
                "expiredAt": 1762794000000,
                "amount": 500000,
                "category": null,
                "status": "unpaid",
                "index": 3,
                "link": "h8fiobqkek",
                "description": "Cicil Produk Kelas Online 3 Bulan",
                "interestAmount": 0,
                "remainingAmount": 0
            }
        ]
    }
}

Endpoint:

https://api.mayar.id/hl/v1/installment/{id}

https://api.mayar.io/hl/v1/installment/{id}

Authorization

string

required

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

Path Parameter

string

required

A unique identifier obtained when creating an installment. If accessed through the dashboard, it can be found at the URL on the installment details page.Example:ba82c2dd-06c1-4b6c-bc59-a9c00801c842

Response

Successful Response

Main Structure (Root Object)

integer

Status code form API.

string

Status message that describes the status code.

array of object

Main response data.

data Structure (Array Of Object)

string

Main ID (UUID).

integer

Creation time (timestamp in ms).

string

Installment period (example: "MONTHLY").

integer

Installment duration (in months).

integer

Due date value (example: 11).

integer

Interest value.

string

Type of interest (example: "FLAT").

string<uuid>

Associated Payment Link ID.

integer

Last update time (timestamp in ms).

string<uuid>

User ID.

array of object

Payment link details.

array of object

List of invoices.

PaymentLink Structure (Array Of Object)

string<uuid>

Payment link ID.

string

Customer name for the payment link.

integer

Total payment amount.

string

Description of the payment.

string<uuid>

Customer ID.

invoices Structure (Array Of Object)

string<uuid>

Invoices ID.

integer

Expiration time of the installment created.

integer

nvoice amount.

string | null

Invoice category.

string

Payment status (example: "unpaid").

integer

IInvoice order number.

string

Unique invoice link.

string

Invoice description.

integer

Interest amount for the invoice.

integer

Remaining balance for this invoice.

API documentation

Product

Generic Link Product

Digital Product

Webinar Product

Event Product

Invoice

Request Payment

Installment

Discount & Coupon

Customer

Transaction

Webhook

Software License Code

Membership (SaaS)

Membership (Credit)

Credit Based Product

Reviews

Authorization

Path Parameter

Response

Main Structure (Root Object)

data Structure (Array Of Object)

PaymentLink Structure (Array Of Object)

invoices Structure (Array Of Object)

​Authorization

​Path Parameter

​Response

​Main Structure (Root Object)

​data Structure (Array Of Object)

​PaymentLink Structure (Array Of Object)

​invoices Structure (Array Of Object)

Authorization

Path Parameter

Response

Main Structure (Root Object)

data Structure (Array Of Object)

PaymentLink Structure (Array Of Object)

invoices Structure (Array Of Object)