1. Overview
Support with the QR dynamic or static code generated with payment amount and fee.
2. API Specification
Endpoint |
|
Service Code | 47 |
3. Request
3.1. Request Header
Name | Type | M/O | Description | Sample |
---|---|---|---|---|
Content-Type | application/json | M | Content type | application/json |
Authorization | String | M | / | Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a" |
X-TIMESTAMP | String | M | yyyy-MM-dd HH:mm:ss | 2020-12-17T10:55:00+07:00 |
X-SIGNATURE | String | M | / | 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c8625 61b19a5 |
ORIGIN | String | M | / | |
X-PARTNER-ID | String | M | / | 82150823919040624621823174737537 |
X-EXTERNAL-ID | String (36) | M | / | 41807553358950093184162180797837 |
CHANNEL-ID | String | M | / | 95221 |
3.1.1 Sample Request Header
Content-type: application/json Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a" X-TIMESTAMP: 2020-12-17T10:55:00+07:00 X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5 ORIGIN: www.hostname.com X-PARTNER-ID: 82150823919040624621823174737537 X-EXTERNAL-ID: 41807553358950093184162180797837 CHANNEL-ID: 95221
3.2 Request Body
Field | Type | Mandatory | Length | Description |
PartnerReferenceNo | String | O | 50 | Transaction identifier on client system |
Amount | Object | O | Mandatory for static / dynamic QR with specified amount | |
value | String | M | 10 | Net amount of the transaction |
currency | String | M | 3 | Currency with ISO4217 |
feeAmount | Object | O | Mandatory if partner charge the fee to customers | |
value | String | M | 6 | Transaction fee |
currency | String | M | 3 | Currency |
merchantId | String | O | 12 | Use the MID as a unique identifier Mandatory to send this value to BNC |
subMerchantId | String | O | 12 | Sub merchant ID Mandatory to send this value to BNC if partner have multi-merchant |
storeId | String | O | 12 | Unique shop id from merchant side Mandatory to send this value to BNC if partner have multi-store |
terminalId | String | O | 32 | Terminal Identification Mandatory with value A01 |
validityPeriod | String | O | 10 | The time when the QRIS valid For dynamic QR this field is Mandatory, and should not be more than 1800s. No validityPeriod for static QR as it is permanent. Once the dynamic QR exceeds the time limit, it will be turned to canceled status, here this case will not trigger the transaction status notification. |
tipType | String | M | 2 | Choose the fee type as: |
additionalinfo | Object | Additional information | ||
tipRate | String | O | 5 | Need to have once the tipType go with 03 |
qrType | String | M | 2 | Choose the code type as Mandatory to send this info to BNC |
deviceId | String | O | / | |
channel | String | O | / |
3.2.1 Sample Request Body
{ "additionalInfo":{ "qrType":"12", // 12 is dynamic code, 11 is static code "tipType":"01" }, "amount":{ "currency":"IDR", "value":"100000" }, "partnerReferenceNo":"2023041150629371689927437", //optional parameter, Unique generated by merchants. "merchantId":"", "subMerchantId":"", "storeId":"", "validityPeriod":"1800" }
4.1 Response Body
4.1.1 Sample Response Body
Field | Type | Mandatory | Length | Description |
responseCode | String | M | 7 | Response code |
responseMessage | String | M | 256 | Response description |
referenceNo | String | O | 32 | Transaction identifier on BNC service system |
partnerReferenceNo | String | O | 50 | Transaction identifier on client system |
qrContent | String | O | QR string MPM | |
qrUrl | String | O | 256 | QR URL for download QR Image |
storeId | String | O | 12 | unique shop id in merchant side |
terminalId | String | O | 32 | Teminal Identification |
additionalInfo | Object | |||
traceId | String | O | 64 | / |
qrType | String | O | 2 | / |
tipType | String | O | 2 | / |
tipRate | String | O | 5 | / |
scID | String | O | 64 | / |
deviceId | String | O | / | |
channel | String | O | / |
Success:
{ "qrContent":"00020101021226740025ID.CO.BANKNEOCOMMERCE.WWW011893600490571007814702120005900003070303UME51550025ID.CO.BANKNEOCOMMERCE.WWW0215ID33334489897650303UME52040780530336054061000005502015802ID5920Master Merchant-07096012TORAJA UTARA6105918526233012230016823037228462858250703A0163048144", "qrUrl":"https://sit-marketing-img.bankneo.co.id/qris/merchant/img/Lm19XwHDeD_IQx6ltH7eoF-aDsgyitWV885D5-pOG8k.png", "referenceNo":"2023072115548417896116252", // Transaction identifier on BNC service system (unique) "additionalInfo":{ "traceId":"02cf941527240a48b89bb01ef2f83437", "scID":"" }, "partnerReferenceNo":"2023041150629371689927437", //The value of the request parameter partnerReferenceNo "responseMessage":"Successful", "storeId":"", "responseCode":"2004700" }
5. Reference
Field Code | Field Name | Description | |
---|---|---|---|
1 | M | Mandatory | Mandatory |
2 | ME | Mandatory Equal | Mandatory Equal – value in the request and the response must be the same. |
3 | C | Conditional | Conditional |
4 | CE | Conditional Equal | Conditional Equal – value in the request and the response must be the same. |
5 | O | Optional | Optional |