Direct Debit Payment
Spesifikasi
Tabel berikut adalah spesifikasi dari API ini :
API Name | Direct Debit Payment |
---|---|
Function | API ini digunakan untuk memulai pembayaran dari platform pedagang ke Paydia |
Service Code | 54 |
Method | POST |
URL | /snap/v1.0/debit/payment-host-to-host |
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 | Mandatory | - | Jenis konten, nilai selalu application/json |
2 | Authorization | String | Variabel | Opsional | Jika opsi Signature adalah pendekatan asimetris | Mengandung B2B Bearer JWT Token, Anda memperolehnya dari Access Token B2B |
3 | Authorization-Customer | String | Variabel, maksimal 64 | Mandatory | - | Mengandung token pelanggan, Anda memperolehnya dari Access Token B2B2C |
4 | X-TIMESTAMP | String | Tetap, maksimal 25 | Mandatory | - | Tanggal dan waktu transaksi, dalam format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
5 | X-SIGNATURE | String | Variabel | Mandatory | - | Signature akan dibuat secara otomatis dengan metode symmetricSignature atau asymmetricSignature |
6 | X-PARTNER-ID | String | Variabel, maksimal 36 | Mandatory | - | ID mitra yang dihasilkan oleh Paydia. ID unik untuk mitra |
7 | X-EXTERNAL-ID | String | Variabel, maksimal 36 | Mandatory | - | ID referensi pesan unik yang dihasilkan oleh pedagang. String numerik. Nomor referensi yang harus unik pada hari yang sama |
8 | CHANNEL-ID | String | Variabel, maksimal 5 | Mandatory | - | Identifikasi perangkat tempat 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 | partnerReferenceNo | String | Variabel, maksimal 64 | Mandatory | - | ID Transaksi dari pedagang |
2 | merchantId | String | Variabel, maksimal 64 | Mandatory | - | Identifier Pedagang yang unik untuk setiap pedagang |
3 | amount | Uang | Variabel | Mandatory | - | Berisi dua sub-bidang:
|
4 | urlParams | Array dari Objek JSON | Variabel | Opsional | - | URL Pemberitahuan yang harus dikirimkan oleh pedagang untuk pemberitahuan pembayaran |
5 | payOptionDetails | Array dari Objek JSON | Variabel | Opsional | - | Pilihan pembayaran yang akan digunakan untuk pembayaran ini |
Contoh Request
Berikut ini adalah contoh permintaan dari API ini:
POST .../snap/v1.0/debit/payment-host-to-host
Authorization-Customer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2NjczNzkzNjcsImV4cCI6MTY2NzM4Mjk2NywianRpIjoiYTdhMjkzODZiNmQ3MWNjMzc4OTkxMDFjNmE1ZWEzZmI0OTRlOWFlYjQxZWRlN2E5OWQzZjkyM2VhNDk3YTZiOCIsImNsaWVudF9pZCI6ImQwTUIiLCJzY29wZSI6IlFVRVJZX0JBTEFOQ0UsUFVCTElDX0lEIiwic3RhdGUiOiI3ZWI0NzRhZC02MzBmLTQ4MjYtYmI2Zi03MDAyZjc2NmQxNTAifQ.RVosor5mXcIZ_k79O8RKokDr4v2NQVLykwsmz61IIf4
X-TIMESTAMP: 2022-11-02T09:14:15+07:00
X-PARTNER-ID: 3068cb31c7981b5c52096c3be18edb38
X-SIGNATURE: P+z6fhC5tqq/cSexU2AMILc7o6lnxYJY2Bm9EFsmhjaCYczCSvGkNKLn4e+ORMhsI3jzmY+aYnrAe0vemY6RAc85aLdUf3PLY780OqvSpX7/eoCwJhx0iCGQs66mytfB6igmwaX0Gm4QpBddNpI+PpZWGXKiwi+IAMjto8bPkFc=' \
X-EXTERNAL-ID: 1667381313
CHANNEL-ID: 12345
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2NjczNzc4NTEsImV4cCI6MTY2NzM4MTQ1MX0.61u_NN-QoLYU3diELlYYBg9T_PesuAnHEHzQMX3TEyI
Content-Type: application/json
{
"partnerReferenceNo": "1667379730635",
"merchantId": "220705002000000",
"amount": {
"value": "1601.00",
"currency": "IDR"
},
"urlParams": [
{
"url": "https://callback.site/",
"type": "PAY_NOTIFY",
"isDeeplink": "Y"
},
{
"url": "https://web-marchant.com",
"type": "PAY_RETURN",
"isDeeplink": "Y"
}
],
"payOptionDetails": [
{
"payMethod": "BALANCE",
"payOption": "BALANCE_PAYDIA",
"transAmount": {
"value": "1601.00",
"currency": "IDR"
}
}
]
}
Response
Bagian berikut akan menjelaskan tentang parameter tanggapan dalam API ini:
Response Params
Tabel berikut adalah daftar parameter tanggapan dalam API ini:
Header
Tabel berikut adalah isi Parameter Body Respon:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Tetap, maksimal 7 | Mandatory | - | Lihat daftar kode tanggapan |
2 | responseMessage | String | Variabel, maksimal 150 | Mandatory | - | Lihat daftar kode tanggapan |
3 | referenceNo | String | Variabel, maksimal 64 | Opsional | Y := Sukses | Identifikasi transaksi Paydia |
4 | partnerReferenceNo | String | Variabel, maksimal 64 | Mandatory | - | ID Transaksi dari pedagang |
5 | webRedirectUrl | String | Variabel, maksimal 2048 | Mandatory | - | URL checkout Paydia |
Contoh Tanggapan
Berikut ini adalah contoh tanggapan dari API ini:
{
"responseCode": "2005400",
"responseMessage": "Successful",
"referenceNo": "202211USMEALRR7p",
"partnerReferenceNo": "1667379730635",
"webRedirectUrl": "https://sb-pwa.paydia.id/bayar/543adbdf..."
}
Response Code dan Response Message
Tabel berikut adalah daftar kode tanggapan dan pesan dari API Direct Debit Payment:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2005400 | Successful | Sukses untuk diproses |
2 | 4005401 | Invalid Field Format | Format tidak valid untuk beberapa bidang |
3 | 4005402 | Invalid Mandatory Field | Hilang atau format tidak valid pada bidang Mandatory |
4 | 4015400 | Unauthorized {reason} | Kesalahan tidak diotorisasi umum |
5 | 4015401 | Invalid Token (B2B) | Token otorisasi tidak valid, mungkin karena kedaluwarsa token untuk B2B |
6 | 4035402 | Exceeds Transaction Amount Limit | Jumlah melebihi batas |
7 | 4045408 | Invalid Merchant | Pedagang tidak ada atau status tidak normal |
8 | 4095400 | Conflict | Tidak dapat menggunakan X-EXTERNAL-ID yang sama dalam satu hari yang sama |
9 | 4095401 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
10 | 5005402 | Backend system failure | Kesalahan server internal 500 |