Skip to content

List Active Methods

Endpoint ini digunakan untuk mengambil struktur hierarkis daftar provider, metode pembayaran, beserta kanal pendukung (bank/gerai) yang saat ini aktif untuk tenant Anda.

Response ini sangat berguna jika Anda ingin merender (membangun UI) halaman checkout di aplikasi klien Anda secara dinamis berdasarkan konfigurasi Dashboard.

Data yang dikembalikan sudah memperhitungkan:

  1. Provider apa yang di-enable (Entitlements)
  2. Routing rule yang Anda set (misalnya: VA diarahkan ke Winpay)
http
GET /v1/active-methods

Request Headers

HeaderTipeRequiredDeskripsi
AuthorizationstringBearer {api_key} atau Bearer {jwt_token}

Response

Endpoint mengembalikan array hierarkis: Providers → Methods → Channels.

Contoh Request

bash
curl -X GET https://gerbang-pay-api.gai.co.id/v1/active-methods \
  -H "Authorization: ApiKey gp_live_xxxxxxxxxxxx"

Contoh Response (200 OK)

json
{
  "success": true,
  "data": {
    "providers": [
      {
        "code": "winpay",
        "name": "winpay",
        "methods": [
          {
            "type": "virtual_account",
            "name": "Virtual Account",
            "channels": [
              { "code": "bca", "name": "BCA" },
              { "code": "bni", "name": "BNI" }
            ]
          },
          {
            "type": "e_wallet",
            "name": "E-Wallet",
            "channels": [
              { "code": "dana", "name": "DANA" },
              { "code": "ovo", "name": "OVO" }
            ]
          }
        ]
      },
      {
        "code": "midtrans",
        "name": "midtrans",
        "methods": [
          {
            "type": "cardless_credit",
            "name": "Cardless Credit",
            "channels": [
              { "code": "akulaku", "name": "AKULAKU" },
              { "code": "kredivo", "name": "KREDIVO" }
            ]
          }
        ]
      }
    ]
  }
}

Tips Penggunaan

  • providers[i].methods[j].type: Merupakan nilai yang harus Anda kirim ke parameter method_type saat memanggil API Create Payment.
  • providers[i].methods[j].channels[k].code: Merupakan nilai yang harus Anda kirim ke parameter internal method_detail (seperti field bank atau wallet_type) saat memanggil API Create Payment.
  • Anda dapat menyembunyikan level "Provider" di UI aplikasi Anda dan langsung menggabungkan (flatten) level "Methods", karena user Anda umumnya hanya peduli dengan "Cara Pembayaran" daripada nama Provider penggeraknya.

Gerbang Pay API Documentation