API Pay-Out - Dokumentasi BestPay

1. Buat Order Pay-Out (创建代付订单)

POST /payment_dfpay_add.html Content-Type: multipart/form-data

Parameter Request

Parameter	Tipe	Wajib	Keterangan	Contoh
orderId	string	Ya	Nomor order merchant	22032816481290241288
amount	integer	Ya	Nominal order, satuan: Rupiah Indonesia, bilangan bulat, rentang nominal 10,000 ~ 25,000,000	113400
address	string	Tidak	Alamat pelanggan, tidak diverifikasi keasliannya	Jakarta
phone	string	Ya	Telepon pelanggan, nomor HP Indonesia 08xxx, angka 0 dihilangkan (untuk bank cukup isi format HP yang benar; untuk e-wallet wajib isi nomor HP yang benar. Format: 628/08/8 + 8-11 digit angka)	85193017660
name	string	Ya	Nama pelanggan, format: huruf Inggris, titik desimal, spasi; mengirim nama asli pengguna meningkatkan tingkat keberhasilan pay-out	YOHAN
sign	string	Ya	Silakan lihat Algoritma Tanda Tangan	212DC6A96B038EBF4CBCF9053DDCDC9A
notifyUrl	string	Ya	Alamat notifikasi callback	http://callback.com/
type	string	Ya	Tipe (`bankcard` atau `ewallet`)	bankcard
dstCode	string	Ya	Kode pay-out (jika type = bankcard, dstCode mengacu ke kode bank pay-out; jika type = ewallet, dstCode mengacu ke kode e-wallet pay-out)	BCA
account	string	Ya	Nomor kartu bank atau akun e-wallet. Format: 9 sampai 18 digit angka, tanpa spasi di tengah	231234567
email	string	Ya	Email pelanggan, format email divalidasi	testEmailwhAJIOWi@gmail.com
memberId	string	Ya	Nomor merchant	10036

Parameter Response

Parameter	Tipe	Keterangan
status	string	Status; `success` = berhasil, `error` = gagal (tidak mewakili keberhasilan bisnis)
msg	string	Deskripsi status
errCode	integer	Kode error
platOrderId	string	Nomor referensi platform; dikembalikan saat berhasil
orderId	string	Nomor order merchant; dikembalikan saat berhasil

Contoh Response Berhasil

{
    "status": "success",
    "msg": "Payment application succeeded",
    "errCode": null,
    "platOrderId": "L0425572201223616",
    "orderId": "CVER220425102700sn4FOFnWTeIw"
}

Contoh Response Gagal

{
    "status": "error",
    "msg": "Insufficient Balance",
    "errCode": 1403
}

2. Query Order Pay-Out (代付订单查询)

POST /payment_dfpay_query.html Content-Type: multipart/form-data

Parameter Request

Parameter	Tipe	Wajib	Keterangan	Contoh
memberId	string	Ya	Nomor merchant	10036
orderId	string	Ya	Nomor order merchant	orderid123455
sign	string	Ya	Tanda tangan	212DC6A96B038EBF4CBCF9053DDCDC9A

Parameter Response

Parameter	Tipe	Keterangan
status	string	Status; `success` = berhasil, `error` = gagal (tidak mewakili keberhasilan bisnis)
msg	string	Deskripsi status
errCode	integer	Kode error status; bernilai Null saat berhasil
memberId	string	Nomor merchant
amount	string	Nominal
cost	string	Nominal biaya
orderId	string	Nomor order merchant
platOrderId	string	Nomor referensi platform
datetime	string	Waktu pemrosesan platform; format: yyyy-mm-dd hh:ii:ss
successTime	string	Waktu berhasil; format: yyyy-mm-dd hh:ii:ss
refCode	integer	Status bisnis: 1 = berhasil, 2 = gagal, 3 = sedang diproses
refMsg	string	Deskripsi bisnis
sign	string	Tanda tangan

Contoh Response Berhasil

{
    "status": "success",
    "msg": "Request succeeded",
    "errCode": null,
    "memberId": "10001",
    "amount": "1134000.00",
    "cost": "8268.00",
    "orderId": "8339132173641741110",
    "platOrderId": "L0425578166866800",
    "datetime": "2021-04-05 11:37:33",
    "successTime": "2021-04-05 11:37:33",
    "refCode": 1,
    "refMsg": "success",
    "sign": "ECBAFA2DAF22199EC8EFB470B6F18E5D"
}

Contoh Response Gagal

{
    "status": "error",
    "msg": "Not fund payout order",
    "errCode": 1407
}

3. Cek Saldo Akun (账户余额查询)

POST /payment_dfpay_balance.html Content-Type: multipart/form-data

Parameter Request

Parameter	Tipe	Wajib	Keterangan	Contoh
memberId	string	Ya	Nomor merchant	10036
sign	string	Ya	Tanda tangan	212DC6A96B038EBF4CBCF9053DDCDC9A

Parameter Response

Parameter	Tipe	Keterangan
status	string	Status
msg	string	Deskripsi status
errCode	integer	Kode error
data.balance	string	Saldo yang dapat ditarik
data.frozen	string	Saldo yang dibekukan (frozen)

Contoh Response Berhasil

{
    "status": "success",
    "msg": "Request succeeded",
    "errCode": null,
    "data": {
        "balance": "100000000",
        "frozen": "0.00"
    }
}

Contoh Response Gagal

{
    "status": "error",
    "msg": "Incorrect signature",
    "errCode": 1003
}

4. Notifikasi Async Pay-Out (disediakan oleh merchant) (代付异步通知)

POST /callback_url Content-Type: application/x-www-form-urlencoded

Interface ini disediakan oleh merchant. Saat pay-out berhasil atau gagal, platform akan me-request interface ini. Saat menerima komunikasi server-ke-server, tampilkan di halaman: “OK” (tanpa tanda kutip, kedua huruf OK kapital).

Parameter yang Dikirim Platform

Parameter	Tipe	Wajib	Keterangan	Contoh
status	string	Ya	Status request; penanda ini bukan penanda berhasil/gagal bisnis	success
memberId	number	Ya	Nomor merchant	10036
amount	number	Ya	Nominal order	1008000
cost	number	Ya	Nominal biaya	11800
platOrderId	string	Ya	Nomor order platform	L0425659248831180
orderId	string	Ya	Nomor order merchant	8339124065844880410
refCode	number	Ya	Status bisnis: 1 = berhasil, 2 = gagal	1
refMsg	string	Ya	Deskripsi bisnis	success
sign	string	Ya	Tanda tangan	E1204CC166AFA7CC6F49BFC7B65C42BE

Response yang Harus Dikembalikan Merchant

OK

Menu Dokumentasi

Parameter Request

Parameter Response

Contoh Response Berhasil

Contoh Response Gagal

Parameter Request

Parameter Response

Contoh Response Berhasil

Contoh Response Gagal

Parameter Request

Parameter Response

Contoh Response Berhasil

Contoh Response Gagal

Parameter yang Dikirim Platform

Response yang Harus Dikembalikan Merchant