1. Overview
After the merchant calls the transfer interface, the bank side triggers a callback notification, which is the result of the cross-bank transfer.
2. API Specification
HTTP Method | POST |
Endpoint |
|
SNAP Service Code | 52 |
3. Request
3.1. Request Header
Name | Type | M/O | Length | Description |
---|---|---|---|---|
X-TIMESTAMP | String | M | 25 | The request timestamp. Formatted with "yyyy-MM-ddTHH:mm:ssZ". E.g. 2022-09-06T13:00:00+07:00 |
X-SIGNATURE | String | M | 2048 | The Merchant or Client generated signature. Using Asymmetric-Signature mechanism to get the token, encrypted with SHA256withRSA. e.g. stringToSign = <HTTP Method> + ":" + <Service Endpoint> + ":" + toLowercase(hexEncode(SHA256(minify(<Request Body>)))) + ":" + <X-TIMESTAMP> X-SIGNATURE = SHA256withRSA(PrivateKey, stringToSign) |
X-ORIGIN | String | M | 256 | Client’s host origin. |
X-PARTNER-ID | String | M | 32 | The Merchant or Client Id. Provided by BNC. |
X-EXTERNAL-ID | String | M | 36 | The Merchant External ID of request.
e.g. 77778042022091500001 |
CHANNEL-ID | String | M | 5 | PJP Channel ID. 88881 |
3.1.1 Sample Request Header
Content-type: application/json Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CUpvIJbU1mMU4a11MNDZ7Sg5u9a" X-TIMESTAMP: 2020-12-21T14:56:11+07:00 X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5 X-ORIGIN: www.hostname.com X-PARTNER-ID: 82150823919040624621823174737537 X-EXTERNAL-ID: 41807553358950093184162180797837 CHANNEL-ID: 95221
3.2 Request Body
Name | Type | M/O | Length | Description | Example |
---|---|---|---|---|---|
originalReferenceNo | String | M | 64 | Transaction identifier on service provider system | 2020102977770000000009 |
originalPartnerReferenceNo | String | O | 64 | Transaction identifier on service consumer system | 2020102900000000000001 |
latestTransactionStatus | String | M | 2 | 00 -Success 06 – Failed 07 - Not found | 00 |
transactionStatusDesc | String | O | 50 | Description status transactio n | success |
customerNumber | String | O | 64 | CustomerAccountNumber | 6281388370001 |
accountType | string | O | 25 | Accounttype | tabungan |
destinationNumber | string | O | 25 | Destination account number | 8377388292 |
destinationAccountName | string | O | 25 | Destination account name | John doe |
amount | Object | O |
|
|
|
value | String | M | 16,2 | Netamount of the transactio n.If it’s IDRthen valueincludes 2 decimal digits.e.g. IDR10.000,- will be placed with10000.00 | 12345678.00 |
currency | String(ISO4217) | M | 3 | Currency | IDR |
sessionID | string | O | 25 | Session id | 0UYEB77329002HY |
bankCode | string | O | 8 | Bank code | 002 |
externalStoreID | String | O | 64 | ExternalStore ID | 124928924949487 |
additionalInfo | Object | O |
| Additional information | { "submerchantflag":"1", "channel":"mobilephone", "sourceAccount":"888801000157157", "amount":"888887.00", "sourceAccountName":"Andrew", "beneficiaryAccountName":"Anthony" "deviceId":"12345679237", "channel": "mobilephone", "referenceNo":"2020102977770000000009", "mchNm": "merchant xyz" } Note: Flag of "submerchantflag": "1" = Merchant (1st tier merchant) "2" = Merchant (2nd tier merchant) |
3.2.1 Sample Request Body
{ }
4. Response
4.1 Response Body
Name | Type | M/O | Length | Description | Example |
---|---|---|---|---|---|
responseCode | String | M | 7 | Responsecode | 2005200 |
responseMessage | Strin g | M | 150 | Response descriptio n | Request hasbeen processed successfully |
additionalInfo | Object | O |
| Additional informatio n | { "submerchantflag":"1", "channel":"mobilephone", "sourceAccount":"888801000157157", "amount":"888887.00", "sourceAccountName":"Andrew", "beneficiaryAccountName":"Anthony" "deviceId":"12345679237", "channel": "mobilephone", "referenceNo":"2020102977770000000009", "mchNm": "merchant xyz" } Note: Flag of "submerchantflag": "1" = Merchant (1st tier merchant) "2" = Merchant (2nd tier merchant) |
4.1.1 Sample Response Body
Success:
{ }
Fail:
{ }
Response Code | HTTP Code | Service Code | Case Code | Response Message | Description | |
---|---|---|---|---|---|---|
1 | 2002400 | 200 | any | 00 | Successful | Successful |
2 | 4002400 | 400 | any | 00 | Bad Request | General request failed error, including message parsing failed. |
3 | 4002401 | 400 | any | 01 | Invalid Field Format {field name} | Invalid format |
4 | 4012400 | 401 | any | 00 | Unauthorized. [reason] | General unauthorized error (No Interface Def, API is Invalid, Oauth Failed, Verify Client Secret Fail, Client Forbidden Access API, Unknown Client, Key not Found) |
5 | 4012401 | 401 | any | 01 | Invalid Token (B2B) | Token found in request is invalid (Access Token Not Exist, Access Token Expiry) |
6 | 4012403 | 401 | any | 03 | Token Not Found (B2B) | Token not found in the system. This occurs on any API that requires token as input parameter |
7 | 4042408 | 404 | any | 08 | InvalidMerchant | Merchant does not exist or status abnormal |
8 | 4042411 | 404 | any | 11 | Invalid Card/Accoun t/Customer [info]/Virtual Account | Card information may be invalid, or the card account may be blacklisted, or Virtual Account number maybe invalid. |
9 | 4042412 | 404 | any | 12 | Invalid Bill/Virtual Account [Reason] | The bill is blocked/suspended/not found.Virtual account is suspend/not found. |
10 | 4042413 | 404 | any | 13 | InvalidAmount | The amount doesn't match with what supposed to |
11 | 4092401 | 409 | any | 01 | Duplicate partnerReferenceNo | Transaction has previously been processed indicates the same partnerReferenceNo already success |
12 | 5002402 | 500 | Any | 02 | External Server Error | Backend system failure, etc |
6. 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 |