Transfer Status

Spesifikasi

Tabel berikut adalah spesifikasi dari API ini :

API Name	Status Transfer
Function	API ini digunakan oleh pedagang untuk melakukan pengecekan status transfer melalui Paydia Bisnis
Service Code	36
Method	POST
URL	/snap/v1.0/transfer/status
Accept	application/json
Content Type	application/json
Related Service	Transfer Status Inquiry Bank

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	If the signature option is asymmetric approach	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	originalPartnerReferenceNo	String	Variable, 64 max	Mandatory	-	Pengidentifikasi transaksi pada sistem mitra
2	originalReferenceNo	String	Variable, 64 max	Mandatory	-	Pengidentifikasi transaksi pada sistem mitra
3	originalExternalId	String	Variable, 32 max	Mandatory	-	Original External-ID pada pesan header
4	serviceCode	String	Variable, maks. 2 karakter	Mandatory	-	Indikator tipe transaksi (service code dari permintaan transaksi asli)
5	transactionDate	String	Variable, maks. 25 karakter	Mandatory	-	Tanggal transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta)
6	amount	Money	Variable	Mandatory	-	Berisi dua sub-field: Value: Jumlah transaksi, termasuk sen Currency: Kode mata uang berdasarkan ISO

Contoh Request

Skrip berikut adalah contoh permintaan pada API ini:

POST .../snap/v1.0/transfer-status
X-TIMESTAMP: 2023-06-16T15:57:03+07:00
X-PARTNER-ID: 8b9583803bcfb36bb9126f050c8f7fad
X-SIGNATURE: VKEeXAzD88E3bLlniA2mxp5qLFWkDyQl30nnuyLAoLa7hETi2KzyuwWLSGd6VeZ60FmAql3ZHgUkAsyvEr9oPg==
X-EXTERNAL-ID: 1664421799
CHANNEL-ID: 12345
Authorization: Bearer 91612be197a76c7e86addd86df3e877feff93d7b758fc60123a54ba7762d015b
Content-Type: application/json
{
  "originalPartnerReferenceNo": "44103f7c-7b61-4d27-abfc-ebe23bd557e2",
  "originalReferenceNo": "3529b507c66a46adaa1ce95959262c1b",
  "originalExternalId": "1686906476",
  "serviceCode": "43",
  "transactionDate": "2023-06-16T16:07:57+07:00",
  "amount": {
    "value": "10000.00",
    "currency": "IDR"
  }
}

Respon

Berikut ini akan menjelaskan tentang parameter respon dari API ini:

Respon Parameter

Tabel berikut ini adalah list dari repson parameter dari API ini:

Body

Tabel berikut adalah isi Parameter Body Respon:

No	Name	Type	Length	Required	Condition	Remarks
1	responseCode	String	Fixed, maks. 7 karakter	Mandatory	-	Lihat daftar kode respons
2	responseMessage	String	Variable, maks. 150 karakter	Mandatory	-	Lihat daftar kode respons
3	originalReferenceNo	String	Fixed, maks. 7 karakter	Mandatory	-	Identifikasi transaksi asli pada sistem mitra
4	originalPartnerReferenceNo	String	Fixed, maks. 7 karakter	Mandatory	-	Identifikasi transaksi asli pada sistem mitra
5	originalExternalId	String	Variable, maks. 32 karakter	Mandatory	-	Original External-ID pada pesan header
6	serviceCode	String	Variable, maks. 2 karakter	Mandatory	-	Indikator tipe transaksi (service code dari permintaan transaksi asli)
7	transactionDate	String	Variable, maks. 25 karakter	Mandatory	-	Tanggal transaksi, dalam format YYYY-MM-DDTHH:mm:ss+07:00. Waktu harus dalam GMT+7 (Waktu Jakarta)
8	amount	Money	Variable	Mandatory	-	Berisi dua sub-field: Value: Jumlah transaksi, termasuk sen Currency: Kode mata uang berdasarkan ISO
9	beneficiaryAccountNumber	String	Variable, maks. 32 karakter	Mandatory	-	Nomor rekening tujuan
10	beneficiaryBankCode	String	Variable, maks. 8 karakter	Mandatory	-	Kode Bank penerima
11	latestTransactionStatus	String	Fixed, maks. 2 karakter	Mandatory	-	Status transaksi. Berisi nilai: 00: Sukses 03: Menunggu 06: Gagal
12	transactionStatusDesc	String	Variable, maks. 32 karakter	Mandatory	-	Deskripsi status transaksi. Berisi nilai: 00: Sukses 03: Menunggu 06: Gagal
13	additionalInfo	JSON Object	Variable	Mandatory	-	Informasi tambahan

Contoh Response

Skrip berikut adalah contoh respon dari API ini:

{
  "responseCode": "2003600",
  "responseMessage": "Successful",
  "originalReferenceNo": "3529b507c66a46adaa1ce95959262c1b",
  "originalPartnerReferenceNo": "44103f7c-7b61-4d27-abfc-ebe23bd557e2",
  "originalExternalId": "1686906476",
  "serviceCode": "43",
  "transactionDate": "2023-06-16T16:07:57+07:00",
  "amount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "beneficiaryAccountNumber": "0123456789",
  "beneficiaryBankCode": "014",
  "latestTransactionStatus": "00",
  "transactionStatusDesc": "Success",
  "additionalInfo": []
}

Response Code dan Response Message

Tabel berikut merupakan list kode respon dan pesan dari API Transfer Status:

No	Response Code	Response Message	Remarks
1	2003600	Successful	Berhasil diproses
2	4003601	Invalid Field Format	Format tidak valid untuk beberapa field tertentu
3	4003602	Invalid Mandatory Field	Field wajib kosong atau memiliki format tidak valid
4	4013600	Unauthorized {reason}	Kesalahan otorisasi umum
5	4013601	Invalid Token (B2B)	Token otorisasi tidak valid, mungkin karena kedaluwarsa untuk B2B
6	4043601	Transaction Not Found	Transaksi tidak ditemukan
7	5003602	Backend system failure	Gagal server internal 500