Welcome to Xendit’s latest documentation. For legacy content, access the previous documentation here or the previous API reference here.

Routing channel pembayaran

Prev Next

API Pembayaran kami dirancang untuk integrasi yang fleksibel dan modular. Dengan menangani 2 parameter utama kami, channel_code dan channel_properties, Anda akan dapat beralih antar channel pembayaran dengan mudah. Jika integrasi diterapkan dengan baik, Anda mungkin dapat mengonfigurasi channel pembayaran baru untuk ditayangkan tanpa kode.

  • Kode channel: parameter yang digunakan untuk memberi tahu Xendit tentang rute pembayaran yang dimaksudkan untuk pemrosesan pembayaran.

  • Properti channel: parameter yang berisi informasi yang diperlukan oleh penyedia rute pembayaran untuk memulai pemrosesan pembayaran.

Tabel pencarian untuk kode channel dan parameter properti channel

Klik pada setiap baris untuk melihat detail lengkap dari setiap skenario.

Definisi parameter properti channel

Properti channel

Definisi

Contoh

success_return_url

panjang string min: 11, panjang maks: 255, harus HTTPS

URL yang ditentukan merchant digunakan untuk pengalihan pengguna akhir setelah pembayaran berhasil di halaman yang dihosting penyedia pembayaran. 

"channel_properties" : {
  "success_return_url" : "https://www.xendit.co/success",
  "failure_return_url" : "https://www.xendit.co/failure"
}

failure_return_url

panjang string min: 11, panjang maks: 255, harus HTTPS

URL yang ditentukan merchant yang digunakan untuk pengalihan pengguna akhir setelah pembayaran gagal di halaman yang dihosting penyedia pembayaran. 

"channel_properties" : {
  "success_return_url" : "https://www.xendit.co/success",
  "failure_return_url" : "https://www.xendit.co/failure"
}

cancel_return_url

panjang string min: 11, panjang maks: 255, harus HTTPS

URL yang ditentukan penjual yang digunakan untuk pengalihan pengguna akhir setelah pengguna akhir memicu pembatalan di halaman yang dihosting oleh penyedia pembayaran.  

"channel_properties" : {
  "success_return_url" : "https://www.xendit.co/success",
  "failure_return_url" : "https://www.xendit.co/failure",
  "cancel_return_url" : "https://www.xendit.co/cancel"
}

pending_return_url

panjang string min: 11, panjang maks: 255, harus HTTPS

URL yang ditentukan merchant digunakan untuk pengalihan pengguna akhir setelah pengguna akhir menyelesaikan langkah-langkah pembayaran di halaman yang dihosting penyedia pembayaran, tetapi status pembayaran akhir belum dikonfirmasi.

"channel_properties" : {
  "success_return_url" : "https://www.xendit.co/success",
  "failure_return_url" : "https://www.xendit.co/failure",
  "pending_return_url" : "https://www.xendit.co/pending"
}

expires_at

string ISO 8601 Stempel Waktu

Stempel waktu yang ditetapkan untuk permintaan pembayaran kedaluwarsa.

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z"
}

payer_name

string

Nama pembayar ditampilkan saat mencoba pembayaran.

Untuk pembayaran Over-The-Counter, staf konter dapat memvalidasi nama pembayar secara langsung terhadap nilai di bidang ini.

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z",
  "payer_name" : "Dlon Mump"
}

display_name

string

Nama yang ditampilkan saat pengguna akhir melalui alur pembayaran.

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z",
  "display_name" : "Dlon Mump"
}

payment_code

Panjang string min: 6, panjang maks: 6

Nomor kode pembayaran yang ditentukan pedagang untuk pembayaran over-the-counter. 

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z",
  "payer_name" : "Dlon Mump",
  "payment_code" : "A1B2C3"
}

virtual_account_number

string

Nomor Virtual Account yang ditentukan pedagang untuk transfer bank. 

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z",
  "payer_name" : "Dlon Mump",
  "virtual_account_number" : "88696969696988"
}

suggested_amount

angka

Jumlah yang diminta saat mencoba pembayaran.

"channel_properties" : {
  "expires_at" : "2024-06-01T11:00:00Z",
  "payer_name" : "Dlon Mump",
  "virtual_account_number" : "88696969696988",
  "suggested_amount" : 1991993
}

Label Uang Tunai

string

Cashtag pembayar yang terdaftar di penyedia pembayaran.

"channel_properties" : {
  "cash_tag" : "iuriuriur"
}

card_details → CVN

panjang string min: 3, panjang maks: 4

Nilai CVN kartu. Kolom ini hanya dapat digunakan langsung di endpoint API kami oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI. 

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → card_number

Panjang min string: 15, panjang maks: 19

Nilai PAN kartu. Kolom ini hanya dapat digunakan langsung di endpoint API kami oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI. 

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → expiry_year

Panjang string min: 4, panjang maks: 4

Nilai tahun kedaluwarsa kartu. Kolom ini hanya dapat digunakan langsung di endpoint API kami oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI. 

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → expiry_month

panjang stringmin: 2, panjang maks: 2

Nilai bulan kedaluwarsa kartu. Kolom ini hanya dapat digunakan oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI. 

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → cardholder_name

panjang string min: 1, panjang maks: 50

Nama pemegang kartu seperti yang ditampilkan pada kartu. Kolom ini hanya dapat digunakan oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI.

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → cardholder_email

panjang string min: 5, panjang maks: 254

email pemegang kartu yang terdaftar di penerbit kartu mereka. Kolom ini hanya dapat digunakan oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI.

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_details → cardholder_phone_number

Panjang string min: 1, panjang maks: 15

Nomor telepon pemegang kartu yang terdaftar di penerbit kartu mereka. Kolom ini hanya dapat digunakan oleh merchant dengan lisensi PCI DSS yang valid. Silakan lihat integrasi SDK Kartu untuk merchant yang tidak bersertifikat PCI.

"channel_properties": {
  "card_details": {
    "cvn": "246",
    "card_number": "2222444466668888",
    "expiry_year": "2027",
    "expiry_month": "12",
    "cardholder_name": "John Doe"
  },
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

mid_label

string

Label MID yang menunjukkan kredensial merchant tertentu yang akan digunakan saat memproses permintaan. Pastikan label MID yang sama digunakan untuk kumpulan transaksi terkait. 

"channel_properties": {
  "mid_label": "mid_label_acquirer_1",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

skip_three_ds

Boolean

Parameter untuk beralih antara memicu 3DS untuk transaksi atau tidak. Parameter ini adalah fitur terbatas di Xendit. Pastikan bahwa akses telah diberikan sebelum melanjutkan.

"channel_properties": {
  "skip_three_ds": false,
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_on_file_type

string

Values yang tersedia:

CUSTOMER_UNSCHEDULED, MERCHANT_UNSCHEDULED, BERULANG

Menunjukkan jenis transaksi kartu tersimpan (card-on-file). Digunakan untuk menginformasikan jaringan tentang bagaimana kartu disimpan dan digunakan (misalnya untuk pembayaran berulang atau transaksi tidak terjadwal).

"channel_properties": {
  "card_on_file_type": "MERCHANT_UNSCHEDULED",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

billing_information

object

Informasi penagihan pemegang kartu yang terdaftar di penerbit kartu mereka. Informasi ini akan digunakan untuk verifikasi alamat selama pemrosesan.

Informasi ini harus disertakan untuk kartu AS, CA, Inggris untuk tingkat keberhasilan yang optimal.

kota: kode negara ISO 3166-2 2 huruf

Negara: Panjang min: 1, Panjang maks: 255

postal_code: Panjang min: 1, Panjang maks: 255

street_line1: Panjang min: 1, panjang maks: 255

street_line2: Panjang min: 1, panjang maks: 255

province_state: Panjang min: 1, panjang maks: 255

"channel_properties": {
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success",
  "billing_information": {
    "city": "Austin",
    "country": "US",
    "postal_code": "78769",
    "street_line1": "Texas Chain Suites",
    "street_line2": "21-37",
    "province_state": "Texas"
  }
}

statement_descriptor

Panjang min string: 5, panjang maks: 22, alfanumerik

Deskripsi yang akan muncul di laporan kartu pengguna akhir. Fitur ini tergantung pada apakah penerbit kartu individu telah menerapkan bidang tersebut.  

"channel_properties": {
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success",
  "statement_descriptor": "Goods & Services"
}

recurring_configuration → recurring_expiry

panjang string min: 10, panjang maks: 10

Tanggal kedaluwarsa jadwal berulang.

"channel_properties": {
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success",
  "recurring_configuration": {
    "recurring_expiry": "YYYY-MM-DD",
    "recurring_frequency": 30
  }
}

recurring_configuration → recurring_frequency

angka

Frekuensi (dalam hari) jadwal berulang.

"channel_properties": {
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success",
  "recurring_configuration": {
    "recurring_expiry": "YYYY-MM-DD",
    "recurring_frequency": 30
  }
}

account_email

panjang string min: 5, panjang maks: 254

Email terdaftar dengan rekening bank yang digunakan.

"channel_properties": {
  "account_email": "payments@xendit.co",
  "account_mobile_number": "+6369692123456",
  "card_last_four": "1234",
  "card_expiry": "06/24",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

account_mobile_number

Panjang string min: 1, panjang maks: 15

Nomor ponsel yang terdaftar di penyedia metode pembayaran.

"channel_properties": {
  "account_email": "payments@xendit.co",
  "account_mobile_number": "+6369692123456",
  "card_last_four": "1234",
  "card_expiry": "06/24",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_last_four

Panjang string min: 4, panjang maks: 4

4 digit terakhir kartu yang terkait dengan rekening bank yang digunakan.

"channel_properties": {
  "account_email": "payments@xendit.co",
  "account_mobile_number": "+6369692123456",
  "card_last_four": "1234",
  "card_expiry": "06/24",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

card_expiry

panjang string min: 5, panjang maks: 5

Tanggal kedaluwarsa kartu yang terkait dengan rekening bank yang digunakan.

"channel_properties": {
  "account_email": "payments@xendit.co",
  "account_mobile_number": "+6369692123456",
  "card_last_four": "1234",
  "card_expiry": "06/24",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

account_identity_number

string

Nomor identifikasi pembayar atau nomor paspor yang terdaftar di penyedia pembayaran.

"channel_properties": {
  "account_identity_number": "12345678901112",
  "account_mobile_number": "+6369692123456",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

payer_email

panjang string min: 5, panjang maks: 254

Email pembayar.

"channel_properties": {
  "email": "payments@xendit.co",
}

device_type

string

Nilai yang tersedia:

DESKTOP, SELULER

Jenis perangkat yang digunakan oleh pembayar. 

"channel_properties": {
  "success_return_url": "https://xendit.co/success",
  "failure_return_url": "https://xendit.co/failure",
  "pending_return_url": "https://xendit.co/pending",
  "device_type": "DESKTOP",
  "payer_ip_address": "192.168.0.1"
}

deskripsi

string

Deskripsi permintaan pembayaran.

"channel_properties": {
  "account_identity_number": "12345678901112",
  "account_mobile_number": "+6369692123456",
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success",
  "description": "https://xendit.co/success"
}

enable_otp

Boolean

Parameter untuk mengaktifkan atau menonaktifkan verifikasi OTP untuk permintaan pembayaran.

"channel_properties": {
  "account_email": "payments@xendit.co",
  "account_mobile_number": "+6369692123456",
  "card_last_four": "1234",
  "card_expiry": "06/24",
  "enable_otp": TRUE,
  "failure_return_url": "https://xendit.co/failure",
  "success_return_url": "https://xendit.co/success"
}

allowed_payment_options

array string

Nilai yang tersedia:

GRABPAY (MYR) -

  • PAYLATER_POSTPAID - Bayar bulan depan

  • PAYLATER_INSTALLMENTS_4MO - Bayar dengan cicilan

Sumber dana tambahan yang dapat digunakan untuk menyelesaikan transaksi. Mungkin ada perbedaan biaya jika sumber dana lain digunakan oleh pembayar. 

"channel_properties": {
  "success_return_url": "https://xendit.co/success",
  "allowed_payment_options": ["PAYLATER_POSTPAID"]
}

redeem_points

string

Nilai yang tersedia:

OVO (IDR), membutuhkan persetujuan dari OVO

  • REDEEM_NONE (default) - Tidak ada poin yang akan digunakan

  • REDEEM_ALL - Poin akan digunakan untuk mengimbangi jumlah pembayaran sebelum saldo kas digunakan.

SHOPEEPAY (IDR)

  • REDEEM_NONE (default) - Tidak ada poin yang akan digunakan

  • REDEEM_ALL - Poin akan digunakan untuk mengimbangi hingga 50% dari jumlah pembayaran sebelum saldo kas digunakan.

Menunjukkan apakah akan menggunakan saldo poin dalam transaksi untuk channel yang memenuhi syarat atau tidak.

"channel_properties": {
  "redeem_points": "REDEEM_NONE"
}

payer_ip_address

Panjang String Minimum: 7, Panjang Maks: 15

Alamat IP klien pembayar (misalnya 192.168.0.1).

WECHATPAY (MYR)

  • Diperlukan jika device_type diatur ke MOBILE

"channel_properties": {
  "success_return_url": "https://xendit.co/success",
  "failure_return_url": "https://xendit.co/failure",
  "pending_return_url": "https://xendit.co/pending",
  "device_type": "MOBILE",
  "payer_ip_address": "192.168.0.1"
}

installment_configuration → istilah

string

Nilai yang tersedia:

BULAN

Nilai yang digunakan n menentukan jadwal cicilan bersama dengan bidang interval.

"channel_properties": {
  "installment_configuration": {
      "terms": [12],
      "interval": "MONTH"
  }
}

installment_configuration → interval

array angka

Satuan waktu yang digunakan dalam menentukan jadwal cicilan.

"channel_properties": {
  "installment_configuration": {
      "terms": [3,6,12],
      "interval": "MONTH"
  }
}