List payment methods

GET/v1/payment-methodsRun

Any API key can call this.

Response (200)

dataarray of objectrequired

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

codestringrequired

The code of the method, as you send it in payment_method.

Example: payment.va.bca

groupstringrequired

Category used to group this method in the payment method list: qris, virtual_account, ewallet, retail or feature.

Example: virtual_account

Possible values: qris, virtual_account, ewallet, retail, feature

feeobject | nullrequired

What Baiyar charges you for the method. Null when a method has no fee of its own.

currencystringrequired

Currency used for the flat fee amounts and fee tiers below.

Example: IDR

Pattern: ^[A-Z]{3}$

flat_amountinteger | nullrequired

The fixed part of the fee, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 450000

percentnumber | nullrequired

Percentage added to the flat fee; 0.7 means 0.7%. Null means there is no percentage part.

Example: 0.7

tiersarray of objectrequired

Fee rules by amount. The base fee applies until an amount is strictly above a tier's above_amount; then that tier's flat and percentage values apply.

above_amountintegerrequired

The threshold an amount must exceed for this fee tier to apply, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 10000000

flat_amountinteger | nullrequired

The fixed part of the fee in this step, in the smallest unit of currency (Rp125.000 is 12500000).

Example: 0

percentnumber | nullrequired

Percentage added to this tier's flat fee; 0.7 means 0.7%.

Example: 0.7

settlement_daysinteger | nullrequired

Expected days after payment until funds reach your available balance. Null when no estimate is set.

Example: 1

statestringrequired

enabled, or not_eligible when your account cannot use it in live yet. A test key can try every method.

Example: enabled

Possible values: enabled, not_eligible

reasonsarray of stringrequired

If state is not_eligible, these codes explain why the method is unavailable for this account. Empty means there is no eligibility issue.

switched_off_bystring | nullrequired

The switch you turned off that closes this method (its own code or its family's); null when none.

Example: string

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-methods" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": [
    {
      "code": "payment.va.bca",
      "group": "virtual_account",
      "fee": {
        "currency": "IDR",
        "flat_amount": 450000,
        "percent": 0.7,
        "tiers": [
          {
            "above_amount": 10000000,
            "flat_amount": 0,
            "percent": 0.7
          }
        ]
      },
      "settlement_days": 1,
      "state": "enabled",
      "reasons": [
        "SUSPENDED"
      ],
      "switched_off_by": "string"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}