Payment Gateway | SNAP Mandatory API

Inquiry

Inquiry merupakan layanan yang digunakan oleh Espay Payment Gateway untuk mengetahui detail transaksi. Anda diminta untuk menyediakan respons berdasarkan format yang sudah disediakan, dan mendaftarkan URL Inquiry Anda di Portal Sandbox Espay. Layanan Inquiry ini bersifat mandatory untuk Anda yang terintegrasi dengan metode Embed Kit dan Direct Integration dengan tipe Virtual Account Dinamis.

Tipe	Value
Kode Layanan	24
Nama	Inquiry
HTTP Method	POST

Flow

Setiap kali terjadi transaksi baru, Espay Payment Gateway akan mengirimkan permintaan ke server Anda melalui URL Inquiry yang telah terdaftar pada Portal Sandbox Espay. Anda diminta untuk memberikan respons dalam bentuk JSON menggunakan format yang disediakan.

API URL

URL Merchant	Endpoint	Keterangan
https://yourdomain.com	.../v1.0/transfer-va/inquiry	Merchant domain URL. Port of HTTPS (443). TLS 1.2

Nama	Tipe	Mandatory	Keterangan
Content-Type	String	Y	Isi konten permintaan Anda. Contoh: application/json
X-TIMESTAMP	String (25)	Y	Tanggal dan waktu lokal customer saat ini. Format: yyyy-MM-ddThh:mi:ssTZD (ISO 8601) Contoh: 2024-03-14T07:49:28+07:00
X-SIGNATURE	String (255)	Y	Kode yang digunakan untuk melakukan validasi transaksi. Pelajari Payment Gateway \| Asymmetric Signature
X-EXTERNAL-ID	String (32)	Y	String Numerik. Kode referensi yang bersifat unik pada hari yang sama.
X-PARTNER-ID	String (50)	Y	Merchant code yang diberikan oleh tim Espay. Contoh: SGWYESSISHOP
CHANNEL-ID	String (5)	Y	Kode channel. Value: ESPAY
Authorization-Customer	String (150)	C	Kode token B2B2C. Khusus Espay -> Bank.

Y: Yes, O: Optional, C: Conditional

Parameter Pemintaan

Parameter	Tipe	Mandatory	Keterangan
partnerServiceId	String (8)	Y	Kode partner. Format: padding space + Espay Value: " Espay"
customerNo	String (20)	Y	Merchant code yang diberikan oleh tim Espay. Contoh: SGWYESSISHOP
virtualAccountNo	String (28)	Y	Kode unik untuk mengidentifikasi pesanan / penagihan / faktur. Contoh: Nomor transaksi, invoice id, dll.
trxDateInit	String (25)	Y	Tanggal dan waktu dari sistem Espay. Format: yyyy-MM-ddThh:mi:ssTZD (ISO 8601). Contoh: 2024-10-24T17:25:40+07:00
inquiryRequestId	String (128)	Y	Kode unik Inquiry dari Espay.

Y: Yes, O: Optional, C: Conditional

Parameter Respons

Parameter	Tipe	Mandatory	Keterangan
responseCode	String (7)	Y	Kode respons. Lihat kode respons di sini. Format: Kode HTTP + Kode Layanan + Kode Error Contoh: 200+24+00 = 2002400.
responseMessage	String (150)	Y	Deskripsi respons. Lihat deskripsi respons di sini.
virtualAccountData	Object	Y
partnerServiceId	String (8)	Y	Kode partner. Format: padding space + Espay Value: " Espay"
customerNo	String (20)	Y	Merchant code yang diberikan oleh tim Espay. Contoh: SGWYESSISHOP
virtualAccountNo	String (28)	Y	Kode unik untuk mengidentifikasi pesanan / penagihan / faktur. Contoh: Nomor transaksi, invoice id, dll.
virtualAccountName	String (255)	Y	Nama customer.
virtualAccountEmail	String (255)	C	Email customer. Khusus pembayaran paylater.
virtualAccountPhone	String (30)	C	Nomor telepon customer. Khusus pembayaran paylater. Format: 62xxxxxxxxx
inquiryRequestId	String (128)	Y	Kode unik Inquiry dari Espay.
totalAmount	Object	Y
value	String (16.2)	Y	Total pembayaran. Format: Desimal .00 Contoh: 150000.00
currency	String (3)	Y	Kode mata uang transaksi. Format: Rupiah: IDR
billDetails	Array of Objects	Y
billDescription	Object	Y
english	String (18)	Y	Deksripsi transaksi (versi bahasa inggris).
indonesia	String (18)	Y	Deksripsi transaksi (versi bahasa indonesia).
additionalInfo	Object	C
token	String (40)	C	Token kartu kredit.
transactionDate	String (25)	Y	Tanggal dan waktu dari merchant. Format: yyyy-MM- ddThh:mi:ssTZD (ISO 8601). Contoh: 2022-08-21T14:56:11+07:00
installmentPeriod	String (3)	C	Periode cicilan khusus pembayaran paylater. Format: 30 Hari: 30D 3 Bulan: 3M 6 Bulan: 6M 12 Bulan: 12M
isInstallment	String (1)	C	Khusus pembayaran kartu kredit. Format: Ya: Y Tidak: N
expiredDatetime	String (25)	O	Waktu dan tanggal kedaluwarsa transaksi. Format: yyyy-MM-ddThh:mi:ssTZD (ISO 8601) Contoh: 2022-08-21T14:56:11+07:00
validationCode	String (100)	C	Kode validasi promosi. Khusus merchant yang menggunakan promotion engine.
dataMerchant	Object	C	Data merchant. Khusus merchant yang menggunakan collection.
listBills	Array of Objects		Cek table Data Merchant (Installment Payment dan Multi Bills).
shippingAddress	Object	C	Alamat pengiriman. Khusus pembayaran paylater.
firstName	String (50)	C	Nama depan.
lastName	String (50)	C	Nama belakang.
address	String (255)	C	Alamat pengiriman.
city	String (50)	C	Kota.
postalCode	String (10)	C	Kode pos.
phoneNumber	String (30)	C	Nomor telepon. Format: 62xxxxxxxxxxxx
countryCode	String (3)	C	Kode negara. Format: ISO 3166 Alpha 3. Contoh: IDN
items	Array of Objects	C	Daftar item pembelian. Khusus pembayaran paylater.
id	String (10)	C	Kode item.
name	String (50)	C	Nama item.
price	String (16)	C	Harga item. Format: Integer (Harga harus pembulatan) Contoh: 150000
type	String (50)	C	Tipe atau kategori item.
url	String (100)	C	Url item.
quantity	String (16)	C	Kuantitas Pembelian item. Format: Integer (harus angka bulat). Contoh: 10

Y: Yes, O: Optional, C: Conditional

Data Merchant - Installment Payment

Parameter	Tipe	Mandatory	Keterangan
kodeCa	String (8)	C	Kode CA merchant.
kodeSubCa	String (8)	C	Sub kode CA merchant.
namaPelanggan	String (100)	Y	Nama customer.
noKontrak	String (12)	Y	Nomor kontrak customer.
angsuranKe	String (2)	Y	Nomor angsuran.
jmlBayarExcAdm	String (16.2)	C	Total pembayaran (diluar biaya admin). Format: Desimal .00 (ISO 4217) Contoh: 50000.00
denda	String (16.2)	C	Total denda. Format: Desimal .00 (ISO 4217) Contoh: 50000.00
feeCa	String (16.2)	C	Biaya kode agen. Format: Desimal .00 (ISO 4217) Contoh: 50000.00
feeSwitcher	String (16.2)	C	Biaya pengalih. Format: Desimal .00 (ISO 4217) Contoh: 50000.00
totalAdmin	String (16.2)	C	Biaya admin. Format: Desimal .00 (ISO 4217) Contoh: 50000.00
jumlahBayar	String (16.2)	Y	Total pembayaran. Format: Desimal .00 (ISO 4217) Contoh: 150000.00
minimumAmount	String (16.2)	C	Minimum pembayaran cicilan. Format: Desimal .00 (ISO 4217) Contoh: 150000.00
totalAngsuran	String (4)	C	Total angsuran customer. Contoh: 48
customer	Object	C
email	String (100)	C	Email customer.
jatuhTempo	Date	C	Jatuh tempo pembayaran. Format: yyyy-MM-dd Contoh: 2025-03-10

Y: Yes, O: Optional, C: Conditional

Data Merchant - Multi Bills

Parameter	Tipe	Mandatory	Keterangan
listBills	Array of Object	C
billCode	String (2)	Y	Kode tagihan customer. Contoh: 01, 02, 03 dsb.
billName	String (20)	Y	Nama tagihan.
billAmount	Object	Y	Total tagihan.
value	String (16.2)	Y	Total tagihan. Format: Desimal .00 (ISO 4217) Contoh: 150000.00
currency	String (3)	Y	Kode mata uang transaksi. Format: Rupiah: IDR
billSubCompany	String (5)	C	Sub perusahaan tagihan.

Y: Yes, O: Optional, C: Conditional

Pendaftaran URL

Pastikan format URL dan respons yang Anda buat sudah sesuai dengan panduan dokumentasi ini. Selanjutnya, segera daftarakan URL Inquiry Anda melalui portal Sandbox Espay. Baca cara menambahkan URL disini.

Sample Headers


Content-Type:application/json
X-TIMESTAMP:2024-03-14T07:49:28+07:00
X-SIGNATURE:Ae668CcZjeuMGF6VPU2qYffMn093O/te89fGERTM2j1dm1AnOiWd5J9fSRCgG8l2vp+5Ij6PqeC7vkircm5ZQw==
X-EXTERNAL-ID:9299e5ee-82ff-4a67-ad59-06ce5cf5fba2
X-PARTNER-ID:SGWYESSISHOP
CHANNEL-ID:ESPAY

Sample Request


{
    "partnerServiceId":" Espay",
    "customerNo":"SGWYESSISHOP",
    "virtualAccountNo":"ORDER0001",
    "trxDateInit":"2024-10-24T17:25:40+07:00",
    "inquiryRequestId":"abcdef-123456-abcdeg"
}

Sample Positive Response


{
    "responseCode": "2002400",
    "responseMessage": "Success",
    "virtualAccountData": {
        "partnerServiceId": " Espay",
        "customerNo": "SGWYESSISHOP",
        "virtualAccountNo": "DIGOERDER00001",
        "virtualAccountName": "Jokul Doe",
        "virtualAccountEmail": "[email protected]",
        "virtualAccountPhone": "6281828384858",
        "inquiryRequestId": "abcdef-123456-abcdef",
        "totalAmount": {
            "value": "890000.00",
            "currency": "IDR"
        },
        "billDetails": [
            {
                "billDescription": {
                    "english": "Tagihan No 123456",
                    "indonesia": "Invoice No 123456"
                }
            }
        ],
        "additionalInfo": {
            "token": "2023011167618274122",
            "transactionDate": "2022-08-21T14:56:11+07:00",
            "dataMerchant": {
                "kodeCa": "880105",
                "kodeSubCa": "-",
                "noKontrak": "060223118342",
                "namaPelanggan": "Yories Yolanda",
                "angsuranKe": "15",
                "jmlBayarExcAdm": 5000000.00,
                "denda": 0.00,
                "feeCa": 5000.00,
                "feeSwitcher": 0.00,
                "totalAdmin": 5000.00,
                "jumlahBayar": 5005000.00,
                "minimumAmount": 2000000.00,
                "totalAngsuran": 48,
                "customer": {
                    "email": "[email protected]"
                },
                "jatuhTempo": "2025-03-10",
                "listBills": [
                    {
                        "billCode": 01,
                        "billName": "Bill Invoice 1",
                        "billAmount": {
                            "value": "70000.00",
                            "currency": "IDR"
                        },
                        "billSubCompany": "00001"
                    },
                    {
                        "billCode": 02,
                        "billName": "Bill Invoice 2",
                        "billAmount": {
                            "value": "50000.00",
                            "currency": "IDR"
                        },
                        "billSubCompany": "00002"
                    }
                ]
            },
            "shippingAddress": {
                "firstName": "Jokul",
                "lastName": "Doe",
                "address": "Jl. Teknologi Indonesia No. 25",
                "city": "Jakarta",
                "postalCode": "12960",
                "phoneNumber": "6281828384858",
                "countryCode": "IDN"
            },
            "items": [
                {
                    "id": "1",
                    "name": "Newlook Charm",
                    "price": "10000",
                    "type": "Contact Lens",
                    "url": "https://domain.com/products/detail?id=1",
                    "quantity": "1"
                },
                {
                    "id": "2",
                    "name": "Newlook Playful",
                    "price": "10000",
                    "type": "Contact Lens",
                    "url": "https://domain.com/products/detail?id=2",
                    "quantity": "1"
                }
            ]
        }
    }
}

Sample Negative Response


{
    "responseCode": "4012400",
    "responseMessage": "Unauthorized Signature"
}

HTTP


POST /api/v1.0/transfer-va/inquiry HTTP/1.1
Host: merchant-domain
Content-Type: application/json
X-TIMESTAMP: 2024-03-14T07:49:28+07:00
X-SIGNATURE: Ae668CcZjeuMGF6VPU2qYffMn093O/te89fGERTM2j1dm1AnOiWd5J9fSRCgG8l2vp+5Ij6PqeC7vkircm5ZQw==
X-EXTERNAL-ID: 9299e5ee-82ff-4a67-ad59-06ce5cf5fba2
X-PARTNER-ID: SGWYESSISHOP
CHANNEL-ID: ESPAY

{
    "partnerServiceId":" ESPAY",
    "customerNo":"SGWYESSISHOP",
    "virtualAccountNo":"ORDER0001",
    "trxDateInit":"2024-10-24T17:25:40+07:00",
    "inquiryRequestId":"abcdef-123456-abcdeg"
}

CURL


curl --location 'https://merchant-domain/api/v1.0/transfer-va/inquiry' \
--header 'Content-Type: application/json' \
--header 'X-TIMESTAMP: 2024-03-14T07:49:28+07:00' \
--header 'X-SIGNATURE: Ae668CcZjeuMGF6VPU2qYffMn093O/te89fGERTM2j1dm1AnOiWd5J9fSRCgG8l2vp+5Ij6PqeC7vkircm5ZQw==' \
--header 'X-EXTERNAL-ID: 9299e5ee-82ff-4a67-ad59-06ce5cf5fba2' \
--header 'X-PARTNER-ID: SGWYESSISHOP' \
--header 'CHANNEL-ID: ESPAY' \
--data '{
    "partnerServiceId":" ESPAY",
    "customerNo":"SGWYESSISHOP",
    "virtualAccountNo":"ORDER0001",
    "trxDateInit":"2024-10-24T17:25:40+07:00",
    "inquiryRequestId":"abcdef-123456-abcdeg"
}'

Apa yang mau anda cari?

Inquiry

Flow

API URL

Header

Parameter Pemintaan

Parameter Respons

Data Merchant - Installment Payment

Data Merchant - Multi Bills

Pendaftaran URL