Channel Instructions

Mengambil panduan atau langkah-langkah pembayaran untuk channel bank tertentu. Informasi ini dapat Anda tampilkan secara langsung pada antarmuka aplikasi Anda kepada pelanggan.

Setiap channel bank mungkin memiliki instruksi yang berbeda-beda. Gunakan channel_id yang didapatkan dari response Payment Account atau Payment Create untuk mengambil panduan langkah demi langkah tersebut.

Request

Endpoint

Method	URL
GET	https://api.bayar.digital/gateway/channels/{channel_id}/instructions

Parameter

Parameter	Tipe	Wajib	Deskripsi
channel_id	uuid	Ya	ID channel (didapatkan dari response GET /gateway/accounts)

Header

Header	Wajib	Deskripsi
X-Api-Key	Ya	API Key merchant Anda

Body

Field	Tipe	Wajib	Deskripsi
Tidak ada body pada request ini.

Contoh

curl https://api.bayar.digital/gateway/channels/660e8400-e29b-41d4-a716-446655440001/instructions \
  -H "X-Api-Key: pk_..."

Response

Sukses

Field	Tipe	Deskripsi
channel_id	uuid	ID channel terkait
instructions	array	Daftar urutan langkah-langkah pembayaran

Format Objek di dalam instructions

Atribut	Tipe	Deskripsi
step	int	Nomor urutan langkah
title	string	Judul atau ringkasan langkah
content	string	Penjelasan detail dari langkah tersebut

200 OK

{
  "success": true,
  "message": "ok",
  "data": {
    "channel_id": "660e8400-e29b-41d4-a716-446655440001",
    "instructions": [
      {
        "step": 1,
        "title": "Buka aplikasi BCA Mobile",
        "content": "Login ke aplikasi BCA Mobile Anda"
      },
      {
        "step": 2,
        "title": "Pilih m-Transfer",
        "content": "Pilih menu m-Transfer > ke Rekening BCA Virtual Account"
      },
      {
        "step": 3,
        "title": "Masukkan nominal",
        "content": "Transfer sesuai total yang tertera"
      }
    ]
  }
}

Gagal

Code	Status	Keterangan
channel_id is required	400	Parameter channel_id tidak disertakan pada URL
tenant_api_key_required	403	API Key tidak valid atau tidak disertakan
internal_error	500	Terjadi kendala pada server, silakan coba beberapa saat lagi

400 Bad Request

{
  "success": false,
  "code": "channel_id is required",
  "message": "channel id is required"
}