Credit Card Subscription
Credit Card Subscription Query API
Panduan mengecek status langganan kartu kredit.
Request URL
URL: ${ROOT_URL}/cc/v1/sub/querysub
HTTPMethod: POST
EndpointUrl: /cc/v1/sub/querysub
Subscription Query Request Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Kode unik untuk setiap request |
| merchantId | String(20) | Yes | ID unik yang disediakan oleh payment gateway ke merchant |
| storeId | String(30) | No | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
| paymentType | String(20) | Yes | Nama tipe pembayaran, cek tabel Tipe Pembayaran |
| agreementId | String(32) | Yes | ID Perjanjian, diperoleh via kueri pesanan berlangganan |
Subscription Query Response Parameters
Header
| Field Name | Type | Value | Required |
|---|---|---|---|
| Content-Type | String(30) | Isi dengan nilai "application/json;charset=utf-8" | Yes |
| X-TIMESTAMP | String(29) | Waktu saat ini, dengan format 2022-09-16T16:58:47.964+07:00 | Yes |
| X-SIGNATURE | String(64) | Signature. Untuk selengkapnya cek | Yes |
| X-PARTNER-ID | String(20) | Merchant ID | Yes |
| X-REQUEST-ID | String(64) | ID unik merepresentasikan setiap request yang dikirim | Yes |
Body
| Parameter | Type | Required | Remarks |
|---|---|---|---|
| requestId | String(64) | Yes | Kode unik untuk setiap request |
| errCode | String(32) | No | 0 adalah sukses, untuk lainnya bisa lihat tabel |
| errCodeDes | String(128) | No | Deskripsi error |
| merchantId | String(20) | Yes | ID unik yang disediakan oleh payment gateway ke merchant |
| storeId | String(30) | No | Jika Merchant memiliki cabang dan ingin membuat order dengan ID cabang |
| paymentType | String(20) | Yes | Nama tipe pembayaran, cek tabel Tipe Pembayaran |
| requestAmount | Decimal(12,2) | No | Nominal pada saat permintaan |
| amount | decimal(12,2) | Yes | Nominal dalam Rupiah Indonesia, with 2 decimal places |
| agreementId | String(32) | Yes | ID Perjanjian, dapat diperoleh melalui kueri pesanan berlangganan. |
| createTime | String(16) | No | yyyyMMddHHmmss |
| status | String(32) | No | INIT: Permintaan berlangganan berhasil dibuat, ACTIVE: Subscription aktif, FAILED: Permintaan gagal dibuat |
| expiredDate | String(10) | Yes | Tanggal kedaluwarsa langganan dalam format yyyy-MM-dd |
| notifyUrl | String(200) | No | URL untuk menerima pengingat pembayaran, pembatalan, atau pemberitahuan penyelesaian. |
| returnUrl | String(200) | No | URL pengembalian frontend untuk langganan awal. |
| subTitle | String(128) | Yes | Judul langganan, ditampilkan kepada pengguna. |
| subMessage | String(256) | No | Deskripsi langganan, ditampilkan kepada pengguna. |
| +subInterval | Object | Yes | DAILY: Harian, WEEKLY: Mingguan, MONTHLY: Bulanan. |
| a?Otype | String(10) | Yes | DAILY: Day, WEEKLY: Week, MONTHLY: Month |
| a?Ovalue | Number(2) | Yes | Interval value, from 1 to 99 |
| +productInfo | Object | Yes | Rincian produk/layanan untuk pembayaran berulang. |
| a?Oid | String(10) | Yes | Product ID |
| a?Oname | String(32) | Yes | Product Name |
| a?Oprice | decimal(12,2) | Yes | Nilai dalam Rupiah, mendukung dua angka belakang koma |
| a?Otype | String(20) | Yes | Product Type |
| a?Ourl | String(200) | No | Product URL |
| a?Oquantity | Number(4) | Yes | Product Quantity |
| +paymentInfo | Array<Object> | No | Riwayat transaksi langganan |
| a?OsuccessTime | String(16) | No | yyyyMMddHHmmss |
| a?OplatformTradeNo | String(32) | No | Nomor order di platform Paylabs |
| a?Oamount | Decimal(12,2) | No | Nominal dalam Rupiah Indonesia, with 2 decimal places |
| a?Ostatus | String(32) | No | 01 PENDING 09 FAILED 02 SUCCEEDED |
| a?OtransFeeRate | Decimal(6,6) | No | Rate Transaksi, mendukung enam angka belakang koma |
| a?OtransFeeAmount | Decimal(12,2) | No | Biaya, mendukung dua angka belakang koma |
| a?OtotalTransFee | Decimal(12,2) | No | Total rate biaya layanan transaksi (tidak termasuk vatFee), mendukung dua angka belakang koma |
| a?OvatFee | Decimal(12,2) | No | Pajak, mendukung dua angka belakang koma |
Example
Request
POST /cc/v1/sub/querysub
# HTTP Header
Content-Type: application/json;charset=utf-8
X-TIMESTAMP: 2022-09-16T16:58:47.964+07:00
X-SIGNATURE: xxxxxxxxx
X-PARTNER-ID: 010001
X-REQUEST-ID: xxxxxxxxxxxxxxxxxxxxxxxx
# HTTP Body
{
"merchantId": "010001",
"agreementId": "PY-1762845307.595957",
"requestId": "xxxxxxxxxxxxxxxxxxxxxxxxx",
"paymentType": "StaticCcSub"
}