From 3408b638d820a30ce25377e73b1223cd62d8c006 Mon Sep 17 00:00:00 2001 From: StainleySW Date: Thu, 16 Jun 2022 11:02:14 +0700 Subject: [PATCH] Add bpjs denda product to documentation --- .../core/product/bpjs-denda/inquiry.md | 174 ++++++++++++++++++ .../core/product/bpjs-denda/payment.md | 163 ++++++++++++++++ toc.json | 16 ++ 3 files changed, 353 insertions(+) create mode 100644 docs/postpaid/core/product/bpjs-denda/inquiry.md create mode 100644 docs/postpaid/core/product/bpjs-denda/payment.md diff --git a/docs/postpaid/core/product/bpjs-denda/inquiry.md b/docs/postpaid/core/product/bpjs-denda/inquiry.md new file mode 100644 index 0000000..b9838b1 --- /dev/null +++ b/docs/postpaid/core/product/bpjs-denda/inquiry.md @@ -0,0 +1,174 @@ +# Inquiry BPJS Denda + +API to inquiry BPJS Denda. + +## Path + +Method | Path +---------|---------- + POST | api/v1/bill/check + +## Test Case + +Code | Number | Response +---------|----------|--------- +BPJSDENDA | 099994301101 | Success +BPJSDENDA | 099994301103 | Inquiry - Time Out +BPJSDENDA | 099994301104 | Inquiry - Invoice Has Been Paid +BPJSDENDA | 099994301105 | Inquiry - Incorrect Destination Number +BPJSDENDA | 099994301106 | Payment - Payment Failed +BPJSDENDA | 099994301107 | Payment - Pending / transaction in process +BPJSDENDA | 099994301108 | Payment - MISC Error / Biller System Error + +## Request Body + + +Attributes | Type | Description | Mandatory +---------|----------|---------|---------- +commands | String | Value: `inq-pasca` | Yes +username | String | Your registered phone number | Yes +code | String | Product Code. You can get list of product code in [pricelist api](../../price-list.md) or from pricelist [here](https://iak.id/webapp/pricelist) | Yes +hp | String | BPJS participant number | Yes +ref_id | String | Your order number / reference ID ( must unique ) | Yes +sign | String | Signature. Value: `md5(username+api_key+ref_id)` | Yes + + + +```json +{ + "commands" : "inq-pasca", + "username" : "123123123", + "code" : "BPJSDENDA", + "hp" : "099994301101", + "ref_id" : "091283746511", + "sign" : "6515c5094421834a85ed9ac7a0fe443b", +} +``` + + + +```json + + + inq-pasca + 123123123 + BPJSDENDA + 099994301101 + 091283746511 + 6515c5094421834a85ed9ac7a0fe443b + +``` + + +## Response + + +Attributes | Type | Description | Mandatory +---------|----------|---------|---------- +tr_id | Integer | IAK inquiry ID | Yes +code | String | Product code | Yes +hp | String | BPJS participant number | Yes +tr_name | String | Bill account name | Yes +period | String | Bill period | Yes +nominal | Double | Bill nominal | Yes +admin | Double | Admin fee | Yes +ref_id | String | Your order number / reference ID ( must unique ) | Yes +response_code | String | Response code. See [response code](../../../response-code.md) list | Yes +message | String | Message | Yes +price | Double | Total price that must be paid (nominal + admin fee) | Yes +selling_price | Double | Deducted balance | Yes +desc | Object | Product description | Yes +desc.**kode_cabang** | String | Code of BPJS branch | Yes +desc.**nama_badan_usaha** | String | Name of company | Yes +desc.**nama_cabang** | String | Name of BPJS branch | Yes +desc.**sisa_pembayaran** | String | Residual payment | Yes +desc.**jumlah_peserta** | String | BPJS participant | Yes + + + +```json +{ + "data": { + "tr_id": 239356798, + "code": "BPJSDENDA", + "hp": "099994301101", + "tr_name": "RIS** A* DZUH**", + "period": "0,1", + "nominal": 108810, + "admin": 2500, + "ref_id": "091283746511", + "response_code": "00", + "message": "INQUIRY SUCCESS", + "price": 111310, + "selling_price": 110160, + "desc": { + "nama_badan_usaha": "RESKA MULTI USAHA PT PUSAT", + "kode_cabang": "", + "nama_cabang": "", + "sisa_pembayaran": "", + "jumlah_peserta": 1 + } + }, + "meta": [] +} +``` + + + +```json + + + 239356798 + BPJSDENDA + 099994301101 + RIS** A* DZUH** + 0,1 + 50108810000 + 2500 + 091283746511 + 00 + INQUIRY SUCCESS + 111310 + 110160 + + RESKA MULTI USAHA PT PUSAT + + + + 1 + + +``` + + +## Live Testing + +```json http +{ + "method": "POST", + "url": "https://testpostpaid.mobilepulsa.net/api/v1/bill/check", + "headers": { + "Content-Type": "application/json" + }, + "body": { + "commands": "inq-pasca", + "username": "{your username}", + "code": "BPJSDENDA", + "hp": "099994301101", + "ref_id": "091283746512", + "sign": "{your sign}" + } +} +``` diff --git a/docs/postpaid/core/product/bpjs-denda/payment.md b/docs/postpaid/core/product/bpjs-denda/payment.md new file mode 100644 index 0000000..f3e02c3 --- /dev/null +++ b/docs/postpaid/core/product/bpjs-denda/payment.md @@ -0,0 +1,163 @@ +# Payment BPJS Denda + +API to pay BPJS Denda. + +## Path + +Method | Path +---------|---------- + POST | api/v1/bill/check + +## Request Body + + +Attributes | Type | Description | Mandatory +---------|----------|---------|---------- +commands | String | Value: `pay-pasca` | Yes +username | String | Your registered phone number | Yes +tr_id | Integer | IAK inquiry ID | Yes +sign | String | Signature. Value: `md5(username+api_key+tr_id)` | Yes + + + +```json +{ + "commands" : "pay-pasca", + "username" : "123123123", + "tr_id" : "9732787", + "sign" : "e4fe9e9c8ba737d6897e7f15bb1380a0" +} +``` + + + +```json + + + pay-pasca + 123123123 + 9732787 + e4fe9e9c8ba737d6897e7f15bb1380a0 + +``` + + +## Response + + +Attributes | Type | Description | Mandatory +---------|----------|---------|---------- +tr_id | Integer | IAK inquiry ID | Yes +code | String | Product code | Yes +datetime | String | Transaction time (Format **YmdHis**) | Yes +hp | String | BPJS participant number | Yes +tr_name | String | Bill account name | Yes +period | String | Bill period | Yes +nominal | Double | Bill nominal | Yes +admin | Double | Admin fee | Yes +response_code | String | Response code. See [response code](../../../response-code.md) list | Yes +message | String | Message | Yes +price | Double | Total price that must be paid (nominal + admin fee) | Yes +selling_price | Double | Deducted balance | Yes +balance | Double | Client remaining balance | Yes +noref | String | Biller reference number (if exist) | No +ref_id | String | Your order number / reference ID ( must unique ) | Yes +desc | Object | Product description | Yes +desc.**premi** | String | Amount that need to be paid | Yes +desc.**kode_cabang** | String | Code of BPJS branch | Yes +desc.**nama_cabang** | String | Name of BPJS branch | Yes +desc.**sisa_pembayaran** | String | Residual payment | Yes +desc.**jumlah_peserta** | String | BPJS participant | Yes + + + +```json +{ + "data": { + "tr_id": 239356798, + "code": "BPJSDENDA", + "datetime": "20220616104645", + "hp": "099994301101", + "tr_name": "RIS** A* DZUH**", + "period": "0,1", + "nominal": 108810, + "admin": 2500, + "response_code": "00", + "message": "PAYMENT SUCCESS", + "price": 111310, + "selling_price": 110160, + "balance": 999968076430, + "noref": "239356524", + "ref_id": "091283746511", + "desc": { + "premi": 0, + "kode_cabang": "", + "nama_cabang": "", + "sisa_pembayaran": "", + "jumlah_peserta": 1 + } + }, + "meta": [] +} +``` + + + +```json + + + 239356798 + BPJSDENDA + 20220616104645 + 099994301101 + RIS** A* DZUH** + 0,1 + 108810 + 2500 + 00 + PAYMENT SUCCESS + 111310 + 110160 + 999968076430 + 239356524 + 091283746511 + + 0 + + + + 1 + + +``` + + +## Live Testing + +```json http +{ + "method": "POST", + "url": "https://testpostpaid.mobilepulsa.net/api/v1/bill/check", + "headers": { + "Content-Type": "application/json" + }, + "body": { + "commands": "pay-pasca", + "username": "{your username}", + "tr_id": "239356798", + "sign": "{your sign}" + } +} +``` diff --git a/toc.json b/toc.json index 739f09c..4f556f5 100644 --- a/toc.json +++ b/toc.json @@ -254,6 +254,22 @@ "type": "group", "title": "Products", "items": [ + { + "type": "group", + "title": "BJPS Denda", + "items": [ + { + "type": "item", + "title": "Inquiry", + "uri": "docs/postpaid/core/product/bpjs-denda/inquiry.md" + }, + { + "type": "item", + "title": "Payment", + "uri": "docs/postpaid/core/product/bpjs-denda/payment.md" + } + ] + }, { "type": "group", "title": "BJPS Kesehatan",