Path | /{version}/registration-account-inquiry |
---|---|
HTTP Method | POST |
Version | v1.0 |
SNAP service code | 08 |
Request Header
Field Name | Field Type | Mandatory | Field Description |
---|---|---|---|
Content-type | String | M | Media type of the resource, i.e. application/json |
X-TIMESTAMP | String | M | Client’s current local time in ISO-8601 format |
X-SIGNATURE | String | M | Created using symmetric signature HMAC_SHA512 algorithm |
Authorization | String | M | Represents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token from Access Token B2B API response. |
Authorization-Customer | String | M | Represents access_token of a request; string starts with keyword “Bearer ” followed by access_token from Binding API response |
X-PARTNER-ID | String | M | Unique identifier for merchant. Merchant can send any value. |
X-EXTERNAL-ID | String | M | Numeric string. Reference number that should be unique in the same day or 1 day idempotency key. |
X-DEVICE-ID | String | M | Device identification on which the API services is currently being accessed by the end user (customer) |
CHANNEL-ID | String | M | Channel ID Device identification on which the API services are currently being accessed by the end user. Given by BI. |
Content-type:application/json
Authorization: Bearer gp9HjjEj813Y9JGoqwOeOPWbnt4CupvIJbU1Mmu4a11MNDZ7Sg5u9a
Authorization-Customer : Bearer MjAyMjEwMTM2NjE1OGRiMS00NmM1LTQxMWQtYmU4NC01ODk1ZTdhMjg2NmY6OGNmM2U4NWUtZTc3Mi00NTJmLWFkYmEtNDcyNjRiOWZiZWIw
X-TIMESTAMP:2020-01-01T00:00:00+07:00
X-PARTNER-ID: BMRI
X-SIGNATURE: da1fa417c72d6b91c257e01e54fac824
X-DEVICE-ID: 0987ADCASA
X-EXTERNAL-ID:1234567890123456789
CHANNEL-ID:12345
Request Body
Field Name | Field Type | Mandatory | Field Description |
---|---|---|---|
additionalInfo | Object | O | Some additional info |
additionalInfo.accountId | String | O | Account ID from legacy Core API flow |
{
"additionalInfo":{
“accountId” : “acd52694-0ef6-4439-8ad1-b1dfb8bb111“
}
}
Response Header
Field Name | Field Type | Mandatory | Field Description |
---|---|---|---|
Content-type | String | M | Media type of the resource, i.e. application/json |
X-TIMESTAMP | String | M | Client’s current local time in ISO-8601 format |
Content-type: application/json
X-TIMESTAMP: 2020-01-01T00:00:00+07:00
Response Body
Field Name | Field Type | Mandatory | Field Description |
---|---|---|---|
responseCode | String (7) | M | Error code to specify the error returned. |
responseMessage | String (150) | M | Debug message to provide more information. |
referenceNo | String | M | Debug id to provide more information. |
additionalInfo Only returned in successful response | Object | C | Some additional info |
additionalInfo.accessToken Only returned in successful response | String | C | Access token used for transaction (used for Authorization-Customer header) |
additionalInfo.paymentType Only returned in successful response | C | Some payment type | |
additionalInfo.paymentOptions Only returned in successful response | Object | C | List of payment options |
additionalInfo.paymentOptions.name Only returned in successful response | String | C | Account balance name for each payment options. |
additionalInfo.paymentOptions.active Only returned in successful response | Boolean | C | Flag to mark if payment option is active. |
additionalInfo.paymentOptions.balance Only returned in successful response | Object | C | Linked account balance for each payment options. |
additionalInfo.paymentOptions.balance.value Only returned in successful response | String | C | Account balance value for each payment options. |
additionalInfo.paymentOptions..balance.currency Only returned in successful response | String | C | Account balance currency for each payment options. |
additionalInfo.paymentOptions.token Only returned in successful response | String | C | Token that need to be use on Gopay Tokenization charge request. |
{
"responseCode":"2000800",
"responseMessage":"Request has been processed successfully",
"referenceNo":"19352694-0ef6-4439-8ad1-b1dfb8bbb85f",
"additionalInfo":{
"accessToken": "MjAyMjEwMTM2NjE1OGRiMS00NmM1LTQxMWQtYmU4NC01ODk1ZTdhMjg2NmY6OGNmM2U4NWUtZTc3Mi00NTJmLWFkYmEtNDcyNjRiOWZiZWIw",
"paymentType": "gopay",
"paymentOptions": [
{
"name": "GOPAY_WALLET",
"active": true,
"balance": {
"value": "7985000.00",
"currency": "IDR"
},
"token": "f527bf45-1612-4ec0-bec0-5c407e33adef"
}
]
}
}
{
"responseCode":"5000800",
"responseMessage":"Timeout",
"referenceNo":"19352694-0ef6-4439-8ad1-b1dfb8bbb85f"
}
List of Response Code
Response Code | HTTP Status Code | Response Message |
---|---|---|
2000800 | 200 | Success |
4000802 | 400 | Invalid Mandatory Field |
4010800 | 401 | Unauthorized |
4010801 | 401 | Invalid Token (B2B) |
4010802 | 401 | Invalid Customer Token |
4040805 | 404 | Merchant Is Not Registered For Card Registration Services |
4010802 | 401 | Invalid Customer Token Note: we will return this when the account linking is already INACTIVE. Applies if merchant passes Authorization-Customer on request header. |
4030818 | 403 | Inactive Card/Account/Customer Note: we will return this when the account linking is already INACTIVE. Applies if merchant passes AccountID (from legacy API) on request header. |
5000801 | 500 | Internal Server Error |
5040800 | 504 | Timeout |