Pay-out (pencairan) · Vietnam

API pay-out wilayah Vietnam (VND). Lihat metode pembayaran.

Permintaan

POST/v2.0/disbursement/pay-out

Path permintaan:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

Parameter header

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Isi permintaan application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (mis. ICT +07:00).
X-SIGNATURE	M	String	Tanda tangan isi JSON (lihat Signature).
X-PARTNER-ID	M	String	Your merchantID

Parameter body

Field	Wajib	Tipe	Deskripsi
orderNo	M	String(32)	ID unik merchant, 6–32 alfanumerik.
purpose	M	String(64)	Catatan untuk pembayar, 1–64 karakter UTF-8.
merchant	M	Object	Membungkus merchantId dan field sub-merchant opsional.
merchantId	M	String	merchantId Smilepayz untuk panggilan ini.
merchantName	O	String	Nama tampilan merchant UTF-8.
subMerchantId	O	String	ID sub-merchant.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId.
money	M	Object	Mata uang dan jumlah untuk transaksi ini.
currency	M	String	Tetap VND.
amount	M	Number	Amount
paymentMethod	M	String	Kode (lihat metode pembayaran).
cashAccount	M	String(32)	Nomor rekening bank penerima.
receiver	M	Object	Objek penerima (lihat model Receiver).
name	M	String	Nama lengkap penerima (UTF-8).
phone	O	String	Telepon penerima format lokal.
email	O	String	Email penerima.
callbackUrl	O	String(256)	URL HTTPS notifikasi status async, maks 256 karakter.

---

Contoh body – permintaan pay-out:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "orderNo": "2000102900000000000001",
    "purpose": "Payroll — Da Nang team",
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "currency": "VND",
        "amount": 1000000
    },
    "paymentMethod": "VCB",
    "cashAccount": "9876543210123",
    "receiver": {
        "name": "Nguyen Van An",
        "phone": "84901234567",
        "email": "[email protected]"
    }
}

Respons

HTTP (permintaan)

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Isi application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Parameter body

Field	Wajib	Tipe	Deskripsi
code	M	String	00 sukses, nilai lain error.
message	M	String	Baris hasil terbaca manusia UTF-8.
orderNo	M	String	ID unik merchant, 6–32 alfanumerik.
tradeNo	O	String	tradeNo Smilepayz untuk pesanan ini.
merchant	M	Object	Membungkus merchantId dan field sub-merchant opsional.
merchantId	M	String	merchantId Smilepayz untuk panggilan ini.
merchantName	O	String	Nama tampilan merchant UTF-8.
subMerchantId	O	String	ID sub-merchant.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId.
accountNo	O	String	accountNo settlement jika gateway mengembalikannya.
money	M	Object	Mata uang dan jumlah untuk transaksi ini.
currency	M	String	Tetap VND.
amount	M	Number	Amount
disbursementTime	M	String	Format (yyyy-MM-ddTHH:mm:ss±HH:mm).
channel	M	Object	Muatan saluran (paymentUrl, qrString, …).
paymentMethod	M	String	Kode (lihat metode pembayaran).
cashAccount	M	String	Nomor rekening bank penerima.
accountName	O	String	Nama pemilik rekening.
status	O	String	Nilai enum status pesanan atau status pembayaran.

Contoh body – respons pay-out:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

{
    "code": "00",
    "message": "successful",
    "orderNo": "2000102900000000000001",
    "tradeNo": "1822000109e998347483949",
    "merchant": {
        "merchantId": "20001",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "2000124234782342"
    },
    "money": {
        "currency": "VND",
        "amount": 1000000
    },
    "disbursementTime": "2024-12-17T10:55:00+07:00",
    "channel": {
        "paymentMethod": "VCB",
        "cashAccount": "9876543210123",
        "accountName": "Nguyen Van An"
    },
    "status": "PROCESSING"
}

Notifikasi / callback

HTTP (permintaan)

Field	Wajib	Tipe	Deskripsi
Content-Type	M	String	Isi application/json.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Tanda tangan body callback (lihat panduan callback).

Parameter body

Field	Wajib	Tipe	Deskripsi
orderNo	M	String	ID unik merchant, 6–32 alfanumerik.
tradeNo	M	String	tradeNo Smilepayz untuk pesanan ini.
merchantId	M	String	merchantId Smilepayz untuk panggilan ini.
merchantName	M	String	Nama tampilan merchant UTF-8.
subMerchantId	O	String	ID sub-merchant.
subMerchantName	O	String	Nama UTF-8 untuk subMerchantId.
paymentMethod	M	String	Kode (lihat metode pembayaran).
transactionTime	M	String	Format: yyyy-MM-ddTHH:mm:ss
money	M	Object	Mata uang dan jumlah untuk transaksi ini.
currency	M	String	Tetap VND.
amount	M	Number	Amount
status	M	String	Nilai enum status pesanan atau status pembayaran.

Respons

Penting

Hanya membalas dengan string SUCCESS.

{
    "orderNo": "2000102900000000000001",
    "tradeNo": "1822000109e998347483949",
    "merchantId": "20001",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "VCB",
    "transactionTime": "2024-12-17T10:55:00+07:00",
    "money": {
        "currency": "VND",
        "amount": 1000000
    },
    "status": "SUCCESS"
}

SUCCESS