Get Payment Channels

Endpoint to retrieve the merchant’s enabled payment channel configuration

Request Example

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

Response Example 200

{
    "statusCode": 200,
    "messages": "success",
    "data": {
        "id": "a1b2c3d4-e5f6-4789-a012-3456789abcde",
        "userId": "348e083d-315a-4e5c-96b1-5a2a98c48413",
        "isAkulakuApproved": null,
        "isCreditCardApproved": true,
        "isQRISStaticApproved": null,
        "isAdminFeeBorneByCustomer": true,
        "isChannelFeeBorneByCustomer": true,
        "isRateLimitActive": false,
        "config": [
            {
                "name": "QRIS",
                "status": true,
                "img": "/qris-gpn.png",
                "type": "qris",
                "code": "QRIS"
            },
            {
                "name": "Bank Transfer Mandiri",
                "status": true,
                "img": "/mandiri.png",
                "type": "va",
                "code": "MANDIRI"
            },
            {
                "name": "EWallet OVO",
                "status": true,
                "img": "/ovo.png",
                "type": "ewallet",
                "code": "OVO"
            },
            {
                "name": "Kartu Kredit Debit",
                "status": true,
                "img": "/cc.png",
                "type": "card",
                "code": null
            },
            {
                "name": "Retail Alfamart",
                "status": true,
                "img": "/alfamart.png",
                "type": "retail",
                "code": "ALFAMART"
            },
            {
                "name": "Pay Later Akulaku",
                "status": false,
                "img": "/akulaku.png",
                "type": "paylater",
                "code": "AKULAKU"
            },
            {
                "name": "QRIS Statis",
                "status": false,
                "img": "/qris-gpn.png",
                "type": "qris_static",
                "code": "QRIS_STATIC"
            }
        ],
        "createdAt": 1700000000000,
        "updatedAt": 1714000000000
    }
}

Endpoint:

Production

https://api.mayar.id/hl/v2/payment-channels

https://api.mayar.club/hl/v2/payment-channels

Authorization

Authorization · string · required

Example:

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

Response

Successful Response

Main Structure (Root)

statusCode · integer

Status code returned by the API.

messages · string

Status message that describes the status code.

data · object

The payment-channel configuration object for the merchant.

data Structure (Object)

data.id · string

Unique identifier of the payment-channel configuration record.

data.userId · string

Identifier of the merchant that owns this configuration.

data.isAkulakuApproved · boolean

Whether the Akulaku (paylater) channel is approved for this merchant. May be null when not yet reviewed.

data.isCreditCardApproved · boolean

Whether the credit/debit card channel is approved for this merchant. May be null when not yet reviewed.

data.isQRISStaticApproved · boolean

Whether the static QRIS channel is approved for this merchant. May be null when not yet reviewed.

data.isAdminFeeBorneByCustomer · boolean

Whether the admin fee is charged to the customer rather than the merchant.

data.isChannelFeeBorneByCustomer · boolean

Whether the per-channel fee is charged to the customer rather than the merchant.

data.isRateLimitActive · boolean

Whether rate limiting is currently active for this merchant’s channels.

data.config · array of object

List of available payment channels and their enabled state.

data.config[].name · string

Human-readable channel name (e.g. Bank Transfer Mandiri).

data.config[].status · boolean

Whether the channel is enabled for this merchant.

data.config[].img · string

Relative path to the channel’s logo image.

data.config[].type · string

Channel type. One of qris, va, ewallet, card, retail, paylater, qris_static.

data.config[].code · string

Channel code (e.g. MANDIRI, OVO, ALFAMART). May be null for some channels.

data.createdAt · integer

Creation timestamp (Unix epoch, in milliseconds).

data.updatedAt · integer

Last-update timestamp (Unix epoch, in milliseconds).

Errors

500 · object

Returned when the channel configuration cannot be read: { "statusCode": 500, "messages": "<error>" }.