Transaction History

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Histori Transaksi
Function	API ini digunakan untuk menanyakan histori transaksi user Paydia Bisnis
Service Code	12
Method	POST
URL	/snap/v1.0/transaction-history-list
Accept	application/json
Content Type	application/json
Related Service	Histori Transaksi

Request

Bagian berikut akan menjelaskan tentang Parameter Permintaan dari API ini :

Request Params

Tabel berikut meruapakan list Parameter Permintaan dari API ini:

Header

Tabel berikut adalah Header dari Parameter Permintaan :

No	Name	Type	Length	Required	Condition	Remarks
1	Content-Type	String	Variable, 127 max	Mandatory	-	Tipe Konten, value selalu application/json
2	Authorization	String	Variable	Conditional	Jika opsi tanda tangan adalah pendekatan asimetris	Berisi token JWT dan Token B2B, anda mendapatkannya dari Access Token B2B
3	X-TIMESTAMP	String	Fixed, 25 max	Mandatory	-	Tanggal dan Waktu Transaksi, dengan format YYYY MM-DDTHH:mm:ss+07:00. Waktu harus GMT+7 (Jakarta time)
4	X-SIGNATURE	String	Variable	Mandatory	-	Tanda tangan akan terbuat otomatis dengan metode symmetricSignature atau metode asymmetricSignature
5	X-PARTNER-ID	String	Variable, 36 max	Mandatory	-	ID untuk mitra dibuatkan oleh Paydia. ID unik untuk mitra
6	X-EXTERNAL-ID	String	Variable, 36 max	Mandatory	-	Pesan unik ID referensi dibuat oleh merchant. String Numerik. Nomor referensi harus unik pada hari yang sama
7	CHANNEL-ID	String	Variable, 5 max	Mandatory	-	Identifikasi perangkat, dimana layanan servis API sedang diakses oleh pengguna akhir (pelanggan)

Body

Tabel berikut adalah isi dari Parameter Permintaan:

No	Name	Type	Length	Required	Condition	Remarks
1	partnerReferenceNo	String	Variable, 64 max	Opsional	-	Pengidentifikasi transaksi pada sistem mitra
2	fromDateTime	String	Fixed, 25 max	Opsional	-	Rentang waktu dimulai, dengan format YYYY-MM-DDTHH:mm:ss. Waktu harus dalam UTC. Default: Sekarang - 3 Bulan (DESC ordering)
3	toDateTime	String	Fixed, 25 max	Opsional	-	Rentang waktu berakhir, dengan format YYYY-MM-DDTHH:mm:ss. Waktu harus dalam UTC. Default: Sekarang

Contoh Request

Skrip berikut adalah contoh permintaan dari API ini:

POST .../snap/v1.0/transaction-history
X-TIMESTAMP: 2023-04-26T16:28:03+07:00
X-PARTNER-ID: 8f548c9c439139b2285269e56db6b8ed
X-SIGNATURE: HVbXQ3t0LFSwQeIhsyBKyqzDwPvzEMOWkcvd/meK5FmflPtkAMPgIEnpITcGHGNrXi8yOAsaNLOYwk2/FEp5bKpj9IsEXerCmnAtEs6Ys6pn6SwtGdm+ds99ClppYbJ+D6S1hf+r2NwJ8noFK1CnwxJaN67vj/zKIlNNltsXbJUAlo3FDsoJYXtWS9yda87vzqn2N38xTiYVQrdwQv2uilMZQf/cI92Wejm80W6qiW3sizqo0I3vi3CHUHgE672/Jy1UWAIymPYjGW1WOzfnCWRjG5OcFW1qkUqGt2GIlR7GzlZaduj/mVOnOg+kbQ6BNxdsU+ZbBdADsEwmUsfpIg==
X-EXTERNAL-ID: 1682501289
CHANNEL-ID: 21
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE2ODI1MDEyODAsImV4cCI6MTY4MjUwMjE4MH0.y9xSfph--m7KhGOWXvEvBsvoUNZIuTmTqkg0SyE-tSQ
Content-Type: application/json
{
  "partnerReferenceNo": "2cffbe77-f131-40f0-8a74-a280b6bb80a8",
  "fromDateTime": "2023-04-26T00:00:00+07:00",
  "toDateTime": "2023-04-26T23:59:59+07:00"
}

Response

Berikut ini akan dijelaskan tentang parameter respon dari API ini:

Response Parameter

Tabel berikut adalah list dari parameter respon dari API ini:

Body

Tabel berikut adalah isi Parameter Body Respon:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Fixed, 7 max	Mandatory	-	Lihat daftar kode respon
2	responseMessage	String	Variable, 150 max	Mandatory	-	Lihat daftar kode respon
3	referenceNo	String	Variable, 64 max	Mandatory	-	Pengidentifikasi Transaksi pada sistem Paydia
4	partnerReferenceNo	String	Variable, 64 max	Mandatory	-	Pengidentifikasi Transaksi pada sistem Partner
5	detailData	Array of JSON Object	Variable	Conditional	Y:= Data ditemukan	Berisi data detail riwayat Transaksi

Contoh Response

Skrip berikut adalah contoh respon dari API ini:

{
  "responseCode": "2001200",
  "responseMessage": "Request has been processed successfully",
  "referenceNo": "PRq6bGwTTeoBS0su",
  "partnerReferenceNo": "2cffbe77-f131-40f0-8a74-a280b6bb80a8",
  "detailData": [
    {
      "dateTime": "2023-04-26T08:25:31+07:00",
      "amount": {
        "value": "1666.00",
        "currency": "IDR"
      },
      "remark": "\"update status trx merchant dari QRIS\"",
      "status": "SUCCESS",
      "type": "PAYMENT"
    },
    {
      "dateTime": "2023-04-26T13:57:48+07:00",
      "amount": {
        "value": "993.99",
        "currency": "IDR"
      },
      "remark": "\"update status trx merchant dari QRIS\"",
      "status": "SUCCESS",
      "type": "REFUND"
    },
    {
      "dateTime": "2023-04-26T08:18:10+07:00",
      "amount": {
        "value": "10666.00",
        "currency": "IDR"
      },
      "remark": null,
      "status": "SUCCESS",
      "type": "TOPUP"
    },
    {
      "dateTime": "2023-04-26T08:22:43+07:00",
      "amount": {
        "value": "50000.00",
        "currency": "IDR"
      },
      "remark": "Bayar tiket bioskop Guardian of The Galaxy 3",
      "status": "INIT",
      "type": "SEND_MONEY"
    },
    {
      "dateTime": "2023-04-26T08:22:57+07:00",
      "amount": {
        "value": "10000.00",
        "currency": "IDR"
      },
      "remark": "Jajan Cilok 2 bungkus",
      "status": "INIT",
      "type": "SEND_MONEY"
    },
    {
      "dateTime": "2023-04-26T13:55:58+07:00",
      "amount": {
        "value": "10266.00",
        "currency": "IDR"
      },
      "remark": null,
      "status": "SUCCESS",
      "type": "TOPUP"
    },
    {
      "dateTime": "2023-04-26T15:27:20+07:00",
      "amount": {
        "value": "11006.00",
        "currency": "IDR"
      },
      "remark": null,
      "status": "SUCCESS",
      "type": "TOPUP"
    },
    {
      "dateTime": "2023-04-26T15:30:00+07:00",
      "amount": {
        "value": "10069.00",
        "currency": "IDR"
      },
      "remark": null,
      "status": "SUCCESS",
      "type": "TOPUP"
    }
  ]
}

Response Code dan Response Message

Tabel berikut adalah list kode respon dan pesan dari API history transaksi:

No	Response Code	Response Message	Remarks
1	2001200	Successful	Berhasil diproses
2	4001201	Invalid Field Format	Format field tertentu tidak valid
3	4001202	Invalid Mandatory Field	Kehilangan atau format tidak valid pada field yang Mandatory
4	4011200	Unauthorized {reason}	Kesalahan otorisasi umum
5	4011201	Invalid Token (B2B)	Token otorisasi tidak valid, mungkin karena kedaluwarsa untuk B2B
6	4091200	Conflict	Tidak dapat menggunakan X-EXTERNAL-ID yang sama dalam satu hari
7	4091201	Duplicate partnerReferenceNo	partnerReferenceNo duplikat
8	5001202	Backend system failure	Gagal server internal 500