Get payment limits

GET/v1/payment-limitsRun

Any API key can call this.

Query parameters

project_idstringrequired

The project to read the limits of. Needed with a merchant key.

Example: prj_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with prj_.

Response (200)

dataobjectrequired

The returned object, or an array of objects for a list.

methodsarray of objectrequired

One entry for each payment method of the project.

payment_methodstringrequired

The payment method covered by these limits.

Example: payment.qris

min_amountintegerrequired

Smallest amount one payment can use with this method, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 100000

max_amountintegerrequired

Largest amount one payment can use with this method after its own maximum and the account-level cap are applied, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 100000000

limited_by_levelbooleanrequired

true means the account level is lowering max_amount below the method's own maximum. Completing account verification may raise the account-level limit.

availablebooleanrequired

dailyobject | nullrequired

The daily limit of your account level; null when the level has none.

limitintegerrequired

The most your payments may add up to in a Jakarta day, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 100000000

remainingintegerrequired

Amount still available under today's account-level limit, after payments already counted today, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 87500000

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/payment-limits" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": {
    "methods": [
      {
        "payment_method": "payment.qris",
        "min_amount": 100000,
        "max_amount": 100000000,
        "limited_by_level": false,
        "available": false
      }
    ],
    "daily": {
      "limit": 100000000,
      "remaining": 87500000
    }
  },
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}