Balance Inquiry

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Balance Inquiry
Function	API ini digunakan untuk mempertanyakan saldo pada Paydia Bisnis dan Paydia app's melalui merchant
Service Code	11
Method	POST
URL	/snap/v1.0/balance-inquiry
Accept	application/json
Content Type	application/json
Related Service	Balance Information

Request

Bagian berikut akan menjelaskan 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, maks. 127	Mandatory	-	Jenis konten, nilai selalu application/json
2	Authorization	String	Variabel	Opsional	Jika pilihan Signature adalah pendekatan asimetris	Berisi Token B2B Bearer JWT, Anda mendapatkannya dari Token Akses B2B
3	Authorization-Customer	String	Variabel, maks. 64	Opsional	Jika Anda ingin memeriksa saldo aplikasi Paydia melalui merchant	Berisi token pelanggan, Anda mendapatkannya dari Token Akses B2B2C
4	X-TIMESTAMP	String	Tetap, maks. 25	Mandatory	-	Waktu tanggal 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 digenerate secara otomatis dengan metode symmetricSignature atau asymmetricSignature
6	X-PARTNER-ID	String	Variabel, maks. 36	Mandatory	-	ID untuk mitra yang dihasilkan oleh Paydia. ID unik untuk mitra
7	X-EXTERNAL-ID	String	Variabel, maks. 36	Mandatory	-	ID referensi pesan unik yang dihasilkan oleh merchant. Angka String. Nomor referensi yang harus unik pada hari yang sama
8	CHANNEL-ID	String	Variabel, maks. 5	Mandatory	-	Identifikasi perangkat tempat layanan API sedang diakses oleh pengguna akhir (pelanggan)

Header

Tabel berikut adalah isi dari Parameter Permintaan:

No	Name	Type	Length	Required	Condition	Remarks
1	partnerReferenceNo	String	Variabel, maks. 64	Opsional	-	Akan diisi oleh requestId dari mitra
2	accountNo	String	Variabel, maks. 16	Opsional	Harus diisi jika Authorization-Customer adalah Null (query saldo Paydia Bisnis)	Identifier merchant yang unik untuk setiap merchant
3	balanceTypes	Array of String	Variabel	Opsional	-	Selalu memiliki nilai BALANCE

Contoh Request

Skrip berikut adalah contoh permintaan API ini :

POST .../snap/v1.0/balance-inquiry
Authorization-Customer: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2NjYyMzYyOTMsImV4cCI6MTY2NjIzOTg5MywianRpIjoiMDAwOGRlNGFkMzI3MzgzOWQ4YTg0N2Q3N2RjMDNkNTlkM2MxMTFjZTQ0NGIxMGY0MWQ5M2U1YWJkOGViZmVmNyIsImNsaWVudF9pZCI6ImMwSUUiLCJzY29wZSI6IlFVRVJZX0JBTEFOQ0UsUFVCTElDX0lEIiwic3RhdGUiOiI3MDQ3OTU1Ni04MjJkLTQ2NDUtYmViMS05MjI1OTE3ZDMyYTIifQ.H6-3-bwXcRs6TguzlF2bLeT44J-0jpqBZGdK-5tQ5Zs
X-TIMESTAMP: 2023-04-25T09:30:04+07:00
X-PARTNER-ID: 8f548c9c439139b2285269e56db6b8ed
X-SIGNATURE: ojZlv/XJgmvpVIl1k1AeLeAmn6gz2nCg6MqlbeVV5dUu532H+etRGmz1dwFSlSWSpPpziiwnIlRfTkVuzm7xsfaA7ABtIVhtSS+9IlMp5XuDBygVN283t/iGQZ5eb3z60/kZ0bHoG5jfDgK5ZTF0OBTLQYWBOuflnJ/Qvjt+uJhtm2tnh9bYwbmvs5uH+vyH6nbuH4DuMGzNzmBgNe4guEklvvf3Try7pufen4CUk/yXQLBhnP5Q5maQV4Q9d+P2x8X9egeFTn6vbnqr/IFCvxqraJ4qhk7zxBLkUQ1fOQ6LrB2OUG3B8WlPa8K2U/6KN8AeFnrvVEQIv/irnxW+qA==
X-EXTERNAL-ID: 1682389810
CHANNEL-ID: 943
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2ODIzODk3NDMsImV4cCI6MTY4MjM5MDY0M30.6m2IzKdwJ41xz-Bzdcqo3vAzqgpzI4iQWFB4UXtiAJU
Content-Type: application/json
{
  "partnerReferenceNo": "2022101400004",
  "accountNo": "230105001000000",
  "balanceTypes": [
    "BALANCE"
  ]
}

Response

Berikut ini akan dijelaskan tentang parameter respon pada API ini :

Response ParamsRespon

Tabel berikut adalah daftar parameter respon di API ini :

Header

Tabel berikut adalah isi Parameter Body Respon:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Tetap, maks. 7	Mandatory	-	Lihat daftar kode respon
2	responseMessage	String	Variabel, maks. 150	Mandatory	-	Lihat daftar kode respon
3	referenceNo	String	Variabel, maks. 64	Opsional	-	Nomor referensi
4	partnerReferenceNo	String	Variabel, maks. 64	Opsional	-	Akan diisi oleh requestId dari mitra
5	accountNo	String	Variabel, maks. 32	Opsional	-	Identifier merchant yang terdaftar yang unik untuk setiap merchant
6	name	String	Variabel, maks. 140	Opsional	-	Nama akun pelanggan
7	accountInfo	Array of Object	Variabel	Opsional	-	Daftar, misalnya BALANCE, CASH, QRIS, POINTS, dll
8	accountInfo.balanceType	String	Variabel, maks. 70	Opsional	-	Untuk menentukan jenis saldo yang diharapkan dikembalikan. Akan mengembalikan semua jenis saldo yang tersedia jika parameter ini kosong
9	accountInfo.amount	Uang	Variabel	Mandatory	-	Daftar, jumlah aktif bersih, berisi dua sub-kolom: Nilai: Jumlah transaksi, termasuk sen Mata uang: Kode mata uang berdasarkan ISO
10	accountInfo.floatAmount	Uang	Variabel	Opsional	-	Daftar, jumlah aktif bersih, berisi dua sub-kolom: Nilai: Jumlah transaksi, termasuk sen Mata uang: Kode mata uang berdasarkan ISO
11	accountInfo.status	String	Variabel, maks. 4	Opsional	-	Status akun: 0001 = Akun Aktif 0002 = Akun Ditutup 0004 = Akun Baru 0006 = Akun Terbatas 0007 = Akun Beku

Contoh Response

Skrip berikut adalah contoh respon API ini :

{
  "responseCode": "2001100",
  "responseMessage": "Successful",
  "referenceNo": "QKzbX7UAWv2tuwfc",
  "partnerReferenceNo": "3d75f679-5350-4713-ae1f-3d82647a2166",
  "accountNo": "230105001000000",
  "name": "John Doe",
  "accountInfo": [
    {
      "balanceType": "BALANCE",
      "amount": {
        "value": "962998.00",
        "currency": "IDR"
      },
      "floatAmount": {
        "value": "646992.00",
        "currency": "IDR"
      },
      "status": "0001"
    }
  ]
}

Response Code dan Response Message

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

No	Response Code	Response Message	Remarks
1	2001100	Successful	Berhasil diproses
2	4001101	Invalid Field Format	Format yang tidak valid untuk kolom tertentu
3	4001102	Invalid Mandatory Field	Kehilangan atau format yang tidak valid pada kolom yang Mandatory
4	4011100	Unauthorized {alasan}	Kesalahan otorisasi umum
5	4011101	Invalid Token	Token otorisasi tidak valid, mungkin karena kedaluwarsa untuk B2B
6	4091101	Duplicate partnerReferenceNo	partnerReferenceNo duplikat
7	5001102	Backend system failure	Kesalahan server internal 500