Get Customer Balance

This is endpoint is used to get a customer credit balance.

Request Example

curl --request GET 'https://api.mayar.id/credit/v1/credit/customer/balance?productId=810328a4-6eeb-4680-8f05-8d578da46c40&membershipTierId=261acae0-d6ae-4d8c-adf5-6fb8c2361514&memberId=PQVS4KGY' \
--header 'Authorization: Bearer Paste-Your-API-Key-Here' \
--data ''

Response Example 200

{
    "statusCode": 200,
    "message": "success",
    "customerBalance": 50990,
    "customerBalanceMembership": 0,
    "customerBalanceAddon": 50990
}

Endpoint:

Production

https://api.mayar.id/credit/v1/credit/customer/balance?productId={productId}&membershipTierId={membershipTierId}&memberId={memberId}

https://api.mayar.club/credit/v1/credit/customer/balance?productId={productId}&membershipTierId={membershipTierId}&memberId={memberId}

Authorization

Authorization · string · required

Example:

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

Query Parameters

productId · string · required

The unique identifier of the product associated with the credit balance.

membershipTierId · string · required

The unique identifier of the membership tier associated with the credit balance.

memberId · string

The unique identifier of the member whose credit balance is being queried.

customerId · string

The unique identifier of the customer whose credit balance is being queried balance.

At least one of customerId or memberId must be provided.

Response

Successful Response

statusCode · integer

Status code form API.

messages · string

Status message that describes the status code.

customerBalance · float

Number of total credit balance.

customerBalanceMembership · float

Number of total credit balance with MEMBERSHIP type.

customerBalanceAddon · float

Number of total credit balance with ADD_ON type.