Payment Transaction
Tabel berikut adalah spesifikasi dari API ini :
API Name | Payment Transaction |
---|---|
Function | API ini digunakan oleh pedagang untuk melakukan transfer ke permintaan Bank melalui Paydia Bisnis |
Service Code | 43 |
Method | POST |
URL | /snap/v1.0/emoney/transfer-bank |
Accept | application/json |
Content Type | application/json |
Related Service | Transfer ke Bank |
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 adalah pendekatan asimetris | Mengandung B2B Bearer JWT Token, 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 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 | partnerReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi transaksi pada sistem konsumen layanan |
2 | beneficiaryAccountNumber | String | Variabel, maksimal 32 karakter | Mandatory | - | Nomor rekening tujuan |
3 | beneficiaryBankCode | String | Variabel, maksimal 8 karakter | Mandatory | - | Kode Bank Penerima |
4 | amount | Uang | Variabel | Mandatory | - | Mengandung dua sub-field:
|
Contoh Request
Script berikut adalah contoh permintaan dari API ini:
POST /snap/v1.0/emoney/transfer-bank HTTP/1.1
X-Timestamp: 2023-06-20T14:59:58+07:00
X-Partner-Id: 8f548c9c439139b2285269e56db6b8ed
X-Signature: jcxn/4SQaAR/oB+JkuWg/Dk9jLj0WNDsKX/NoGZocVvf1MR6gQtCEGeSGET5KUbDhTF+UUMpiReS/H91PNC3Ew==
X-External-Id: 1687248158
Channel-Id: 788
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2ODcyNDgwMDcsImV4cCI6MTY4NzI0ODkwN30.hyYOTjtz5sA0-oAPjWxFaC0RsFjE2Ch-LtfdN5ReiG8
{
"partnerReferenceNo": "dedf08cf-854e-4b3b-86f6-6e3512b1f7c7",
"beneficiaryAccountNumber": "0123456789",
"beneficiaryBankCode": "014",
"amount": {
"value": "10000.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 karakter | Mandatory | - | Lihat daftar kode tanggapan |
2 | responseMessage | String | Variabel, maksimal 150 karakter | Mandatory | - | Lihat daftar kode tanggapan |
3 | referenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi transaksi pada sistem Paydia |
4 | partnerReferenceNo | String | Variabel, maksimal 64 karakter | Mandatory | - | Identifikasi transaksi pada sistem mitra |
5 | transactionDate | String | Tetap, maksimal 25 karakter | Mandatory | - | Tanggal transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (waktu Jakarta) |
6 | referenceNumber | String | Variabel, maksimal 64 karakter | Mandatory | - | Nomor referensi |
7 | additionalInfo | Objek JSON | Variabel | Mandatory | - | Informasi tambahan |
8 | additionalInfo.transactionStatus | String | Tetap, maksimal 2 karakter | Mandatory | - | Status transaksi. Mengandung nilai:
|
9 | additionalInfo.transactionStatusDesc | String | Variabel, maksimal 32 karakter | Mandatory | - | Deskripsi status transaksi. Mengandung nilai:
|
10 | additionalInfo.balance | Uang | Variabel | Mandatory | - | Informasi tambahan saldo pedagang. Mengandung dua sub-field:
|
Contoh Tanggapan
Script berikut adalah contoh tanggapan dari API ini:
{
"responseCode": "2004300",
"responseMessage": "Successful",
"referenceNo": "fdf7e3e4fde84bbf8c9590222ae994fd",
"partnerReferenceNo": "dedf08cf-854e-4b3b-86f6-6e3512b1f7c7",
"transactionDate": "2023-06-20T15:02:16+07:00",
"referenceNumber": "fdf7e3e4fde84bbf8c9590222ae994fd",
"additionalInfo": {
"transactionStatus": "00",
"transactionStatusDesc": "Success",
"balance": {
"value": "500000.00",
"currency": "IDR"
}
}
}
Response Code dan Response Message
Tabel berikut adalah daftar kode tanggapan dan pesan dari API Payment Transaction:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2004300 | Successful | Berhasil diproses |
2 | 4004301 | Invalid Field Format | Format tidak valid untuk bidang tertentu |
3 | 4004302 | Invalid Mandatory Field | Kehilangan atau format tidak valid pada bidang Mandatory |
4 | 4014300 | Unauthorized {reason} | Kesalahan izin umum |
5 | 4014301 | Invalid Token (B2B) | Token ditemukan dalam permintaan tidak valid (Access Token Not Exist, Access Token Expiry) |
6 | 4034302 | Exceeds Transaction Amount Limit | Melebihi batas jumlah transaksi |
7 | 4034314 | Insufficient Funds | Dana tidak mencukupi |
8 | 4044303 | Bank Not Supported By Switch | Bank tidak didukung oleh switch |
9 | 4094300 | Conflict | Tidak dapat menggunakan X-EXTERNAL-ID yang sama dalam satu hari yang sama |
10 | 4094301 | Duplicate partnerReferenceNo | partnerReferenceNo duplikat |
11 | 5004302 | Backend system failure | Kesalahan server internal 500 |