1. Overview
Support with the static code transaction list inquiry by partner services.
2. API Specification
Endpoint | |
Service Code | 12 |
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 |
fromDatetime | ISODateTime ISO-8601 | O | 32 | Starting time range. NOW - 1 day(ASC): 2019-07-03T12:08:56-07:00 |
toDateTime | ISODateTime ISO-8601 | O | 32 | Ending time range. Default:NOW(ASC): 2019-07-03T12:08:56-07:00 |
pageSize | int | O | 3 | Maximum number of transaction returned in one organization. Default: 10 |
pageNumber | int | O | 5 | Current page number. Default:0 |
AdditionalInfo | object | O | Additional information | |
scID | String | M | 64 |
3.2.1 Sample Request Body
{
"additionalInfo":{
"scID":"3001689892262664724480" //The scID field value in the response parameter of the static code generation },
"fromDateTime":"2023-01-21T16:49:23+07:00",
"pageNumber":1,
"pageSize":100,
"toDateTime":"2023-08-22T16:49:23+07:00"
}
4.1 Response Body
Field | Type | Mandatory | Length | Description |
responseCode | String | M | 7 | SNAP Response code. |
responseMessage | String | M | 256 | SNAP response message |
detailData | Array | |||
dateTime | ISODateTime ISO-8601 | O | 32 | 2019-07-03T12:08:56-07:00 |
amount | Object | O | ||
value | String | M | 10 | Net amount of the transaction. If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,-will be placed with 10000.00 |
currency | String(ISO4217) | M | 3 | IDR |
remark | String | O | 256 | Transaction remake. |
sourceOfFunds | List<SourceOfFund>See object | O | Source of funds used for this transaction | |
status | String | M | 20 | Transaction status,INIT success,CLOSED,CANCELLED |
type | String | M | 20 | Transaction type. PAYMENT,REFUND |
additionalInfo | Object | O | Additional information from detailDate | |
scID | String | M | 64 | |
originalReferenceNo | String | M | 32 | Transaction identifier on BNC system |
RRN | String | M | 16 | / |
bankCode | String | M | 32 | / |
bankName | String | M | 50 | / |
feeMoney | Object | M | / | |
currency | String | M | 3 | / |
value | String | M | 5 | / |
additionalInfo | Object | O | Additional information | |
total | String | M | 10 | response with the total pages for history |
currentPage | String | M | 5 | / |
hasMore | String | M | 5 | true=has more pages |
channel | String | O | / | |
deviceId | String | O | / |
4.1.1 Sample Response Body
Success:
{
"originalReferenceNo":"2023072115548417896116252",
"referenceNo":"2023072115903492868116253",
"originalExternalId":"",
"refundTime":"2023-07-21T15:29:47+07:00",
"additionalInfo":{
"traceId":"8373480e2ac2b5c7738e64e7348fee56",
"channel":"",
"deviceId":""
},
"originalPartnerReferenceNo":"",
"responseMessage":"Successful",
"partnerRefundNo":"OY!_202307211689928187",
"responseCode":"2007800",
"refundAmount":{
"currency":"IDR",
"value":"1000"
}
}
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 |