Account Unbinding
Specification
The Following tabel is spesification for this API :
API Name | Account Unbinding |
---|---|
Function | This API is used to reverses the account binding process by revoking the accessToken and refreshToken |
Service Code | 09 |
Method | POST |
URL | /snap/v1.0/registration-account-unbinding |
Accept | application/json |
Content Type | application/json |
Related Service | Account Binding & Unbinding |
Request
The following part will be describe about parameter of request in this API:
Request Parameter
The following table is a list of request parameter in this API:
Header
The following table is Header of Request Parameters :
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | Content-Type | String | Variable, 127 max | Mandatory | - | Content type, value always application/json |
2 | Authorization | String | Variable | Mandatory | - | Contains B2B Bearer JWT Token, you've got it from Access Token B2B |
3 | X-TIMESTAMP | String | Fixed, 25 max | Mandatory | - | Transaction date time, in format YYYY-MM-DDTHH:mm:ss+07:00. Time must be in GMT+7 (Jakarta time) |
4 | X-PARTNER-ID | String | Variable, 36 max | Mandatory | - | ID for partner was generated by Paydia. Unique ID for a partner |
5 | X-EXTERNAL-ID | String | Variable, 36 max | Mandatory | - | Unique messaging reference ID generated by merchant. Numeric String. Reference number that should be unique in the same day |
6 | CHANNEL-ID | String | Variable, 5 max | Mandatory | - | Device identification on which the API services is currently being accessed by the end user (customer) |
7 | X-SIGNATURE | String | Variable | Mandatory | - | Signature need to be generated with Symmetric Signature method |
Body
The following table is a body of request parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | partnerReferenceNo | String | Variable, 64 max | Optional | - | Unique transaction identifier on partner system which assigned to each transaction |
2 | merchantId | String | Variable, 64 max | Mandatory | - | Merchant identifier that is unique per each merchant |
3 | additionalInfo | JSON Object | Variable | Mandatory | - | Additional information |
4 | additionalInfo.accessToken | String | Variable, 2048 max | Mandatory | - | A string representing an authorization issued to the client that used to access protected resources. |
Request Sample
The following script is a request sample of this API:
POST /snap/v1.0/registration-account-unbinding
X-TIMESTAMP: 2024-08-01T15:52:53+07:00
X-PARTNER-ID: 35d1a1127182a65e4fe0256242a40a6d
X-EXTERNAL-ID: 1722502381
CHANNEL-ID: 12345
X-SIGNATURE: fkjc/zBC2ch7ZFt6NHrA2DSsY8DnaaOz9o+vbwnN7K1IfBl596J0CrySA5+48/h51rxDfyyAE0Fh4/bxhduIcg==
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjI0OTk0MTYsImV4cCI6MTcyMjU4NTgxNiwiZGF0YSI6eyJlbnYiOiJkZXZlbG9wbWVudCJ9fQ.9MyA71Js2Zx-4Z_5m7h069NPDzDcSJrN-szSvbk-qmk
{
"partnerReferenceNo": "e1e09285-0b21-4872-a9f4-44fc098a2ff3",
"merchantId": "240212001000000",
"additionalInfo": {
"accessToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlkaWEiLCJpYXQiOjE3MjI1MDE1NjAsImV4cCI6MTczODI2OTU2MCwianRpIjoiNGYwYTUzNGZmM2YxZDkyZTg0ZGEwYjE4ZDEwMDA3NjU5OWYxYzIzNDViMzE0NTRhMDdhNjg1NTA0YWE2ODRlZSIsImNsaWVudF9pZCI6ImRVVT0iLCJzY29wZSI6IlBVQkxJQ19JRCIsInN0YXRlIjoiMGYxZDM5YzUtYTc0Ny00YzM5LWE3YTMtZWZhMjUwYjU0ODU4In0.4KspWRa6hVsTWg1DI-vNGoZFRhg-ktti2iiaWYlTabg"
}
}
Response
The following part will be describe about parameter of response in this API:
Response Parameter
The following table is a list of response parameter in this API:
Body
The following table is a body of response parameter:
No | Name | Type | Length | Required | Condition | Remarks |
---|---|---|---|---|---|---|
1 | responseCode | String | Fixed, 7 max | Mandatory | - | Refer to response code list |
2 | responseMessage | String | Variable, 150 max | Mandatory | - | Refer to response code list |
3 | referenceNo | String | Variable, 64 max | Mandatory | - | Transaction identifier on Paydia |
4 | partnerReferenceNo | String | Variable, 64 max | Optional | - | Unique transaction identifier on partner system which assigned to each transaction |
5 | merchantId | String | Variable, 64 max | Mandatory | - | Merchant identifier that is unique per each merchant |
6 | unlinkResult | String | Variable, 64 max | Mandatory | - | Result of unlinking process |
Response Sample
The following script is a response sample of this API:
{
"responseCode": "2000900",
"responseMessage": "Successful",
"referenceNo": "ec0O4zt97AIcC95J",
"partnerReferenceNo": "e1e09285-0b21-4872-a9f4-44fc098a2ff3",
"merchantId": "240212001000000",
"unlinkResult": "success"
}
Response Code and Message
The following table is the list response code and message of Access Token B2B2C API:
No | Response Code | Response Message | Remarks |
---|---|---|---|
1 | 2000900 | Successful | Success to be processed |
2 | 4000901 | Invalid Field Format | Invalid format for certain field |
3 | 4000902 | Invalid Mandatory Field | Missing or invalid format on mandatory field |
4 | 4010900 | Unauthorized. [reason] | General unauthorized error |
5 | 4010901 | Invalid Token (B2B) | Invalid or Expired Access Token |
6 | 4040908 | Invalid Merchant | Merchant does not exist or status abnormal |
7 | 4090900 | Conflict | Cannot use same X-EXTERNAL-ID in same day |
8 | 4090901 | Duplicate partnerReferenceNo | Duplicate partnerReferenceNo |
9 | 5000902 | Backend system failure | 500 internal server error |