Direct Debit Payment Notify

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Direct Debit Payment Notify
Function	API ini digunakan untuk memberi tahu status pembayaran dan informasi dari Paydia ke platform pedagang
Service Code	56
Method	POST
URL	/snap/v1.0/debit/notify
Accept	application/json
Content Type	application/json
Related Service	Direct Debit

Request

Bagian berikut akan menjelaskan tentang parameter permintaan dalam API ini:

Request Params

Tabel berikut adalah daftar parameter permintaan dalam API ini:

Header

Tabel berikut adalah Header dari Parameter Permintaan :

No	Name	Type	Length	Required	Condition	Remarks
1	Content-Type	String	Variabel, maksimal 127 karakter	Mandatory	-	Jenis konten, nilai selalu application/json
2	Authorization	String	Variabel	Opsional	Jika opsi Signature menggunakan pendekatan asimetris	Mengandung Token B2B Bearer JWT, Anda mendapatkannya dari Access Token B2B
3	X-TIMESTAMP	String	Tetap, maksimal 25 karakter	Mandatory	-	Waktu tanggal transaksi, dalam format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta)
4	X-SIGNATURE	String	Variabel	Mandatory	-	Signature akan dihasilkan secara otomatis dengan metode symmetricSignature atau asymmetricSignature
5	X-PARTNER-ID	String	Variabel, maksimal 36 karakter	Mandatory	-	ID untuk mitra yang dihasilkan oleh Paydia. ID unik untuk seorang mitra
6	X-EXTERNAL-ID	String	Variabel, maksimal 36 karakter	Mandatory	-	ID referensi pesan unik yang dihasilkan oleh pedagang. String numerik. Nomor referensi yang harus unik dalam satu hari yang sama
7	CHANNEL-ID	String	Variabel, maksimal 5 karakter	Mandatory	-	Identifikasi perangkat di mana layanan API saat ini diakses oleh pengguna akhir (pelanggan)

Header

Tabel berikut adalah isi dari Parameter Permintaan:

No	Name	Type	Length	Required	Condition	Remarks
1	originalPartnerReferenceNo	String	Variabel, maksimal 64 karakter	Mandatory	-	Identifier transaksi asli pada sistem mitra
2	originalReferenceNo	String	Variabel, maksimal 64 karakter	Mandatory	-	Identifier transaksi asli pada sistem Paydia. Harus diisi setelah transaksi berhasil
3	originalExternalId	String	Variabel, maksimal 36 karakter	Opsional	-	ID eksternal asli pada pesan header
4	merchantId	String	Variabel, maksimal 64 karakter	Mandatory	-	Identifier pedagang yang unik untuk setiap pedagang
5	amount	Money	Variabel	Mandatory	-	Mengandung dua sub-field: Nilai: Jumlah transaksi, termasuk sen Mata uang: Kode mata uang berdasarkan ISO
6	latestTransactionStatus	String	Tetap, maksimal 2 karakter	Mandatory	-	Kode kategori untuk status transaksi. Nilainya meliputi: 00 - Sukses, pesanan telah dibayar 05 - Dibatalkan, pesanan telah ditutup karena telah kedaluwarsa
7	transactionStatusDesc	String	Variabel, maksimal 50 karakter	Opsional	-	Deskripsi status transaksi
8	createdTime	String	Tetap, maksimal 25 karakter	Mandatory	-	Waktu pembuatan transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta)
9	finishedTime	String	Tetap, maksimal 25 karakter	Mandatory	-	Waktu pembuatan transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta)
10	additionalInfo	Objek JSON	Variabel	Opsional	-	Informasi Tambahan

Contoh Request

Berikut ini adalah contoh permintaan dari API ini:

POST .../v1.0/debit/notify
X-TIMESTAMP: 2022-10-21T03:39:47+07:00
X-PARTNER-ID: 7c357677e7e02547ef33fafca165a574
X-SIGNATURE: q422i3tmIVQifwqwEH2R8x6NtigR+qb7mhN1aUPgGSHY5c9Sa8EZNHiQTnTaDY+u+sV9GvhDlufxU7AjYv7mOnrVY/DTaMlxK8muPPZq87TbXdGL1C8zbdsCjrM8sCnOr3+AoFTb2TYpebnUsNYuJjg9K12Qcze5Qk7r+aoCTwRMSbri34y2s5CBKEyDiP1RQ2OShbFOm/11dyjF8h3AVSiuaEzcRxEMdSpINdyfdx1c1Ovmziv8Wu2mTWnQ15FbKs2zNf9ZR+qtudnZ5eWK0n7CHPsnhysL/tjrmazacOS+slF2O/DrH7YX9wFSIMNd0Fq3NQ5lBXf0YM7MSd92XA==
X-EXTERNAL-ID: 1666323677
CHANNEL-ID: 12345
Content-Type: application/json
{
    "originalPartnerReferenceNo": "2022101400007",
    "originalReferenceNo": "202210GluaSCejOX",
    "originalExternalId": "1666322307",
    "merchantId": "220901002000000",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "latestTransactionStatus": "00",
    "transactionStatusDesc": "Success",
    "createdTime": "2022-10-21T10:18:27+07:00",
    "finishedTime": "2022-10-21T10:18:47+07:00",
    "additionalInfo": []
}

Response

Bagian berikut akan menjelaskan tentang parameter Respon dalam API ini:

Response ParamsRespon

Tabel berikut adalah daftar parameter Respon dalam API ini:

Header

Tabel berikut adalah isi Parameter Body Respon:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Tetap, maksimal 7 karakter	Mandatory	-	Lihat daftar kode Respon
2	responseMessage	String	Variabel, maksimal 150 karakter	Mandatory	-	Lihat daftar kode Respon

Contoh Response

Berikut ini adalah contoh Respon dari API ini:

{
  "responseCode": "2005600",
  "responseMessage": "Successful"
}

Response Code dan Response Message

Tabel berikut adalah daftar kode respon dan pesan dari API Balance Inquiry:

No	Response Code	Response Message	Remarks
1	2005600	Berhasil	Berhasil diproses
2	5005602	Kegagalan sistem backend	Kesalahan server internal 500