Request Access Token API - SNAP

9min

About Request Access Token - SNAP
﻿
This part contains detail  related to access token  with  standard uses on  s,   checking, and refund.
﻿
Request Access Token API - SNAP
﻿
Get Access Token
Service Code
﻿API SNAP Service Code﻿﻿
API Endpoint
﻿/nicepay/v1.0/access-token/b2b 
HTTP Method
POST
Description
Request Token for Authentication
Content-type
application/json
API SNAP Service Code
Service Code
Reference API
73
﻿E-Wallet - Access Token﻿﻿
﻿QRIS - Access Token﻿﻿
11
﻿Balance Inquiry - API Payout (Disbursement) SNAP﻿﻿
54
﻿Registration - API E-Wallet (Direct Debit) SNAP﻿﻿
55
﻿Check Status Transaction - API E-Wallet (Direct Debit) SNAP﻿﻿
58
﻿Refund Transaction - API E-Wallet (Direct Debit) SNAP﻿﻿
47
﻿Registration - API QRIS SNAP﻿﻿
51
﻿Check Status Transaction - API QRIS SNAP﻿﻿
78
﻿Refund Transaction - API QRIS SNAP﻿﻿
﻿
Get Header
Request Access Token Header
Header Parameter Name
Type
Attribute
Content
Content-Type
String
Mandatory
Application/JSON
X-TIMESTAMP
String
Mandatory
YYYY-MM-DDTHH:MM:SS
(2022-03-21T10:11:40+07:00) 
X-CLIENT KEY
String
Mandatory
﻿ Provided (X-CLIENT 
KEY = CLIENT_ID)
X-SIGNATURE
String
Mandatory
Generated by / 
created using asymmetric
signature SHA256withRSA algorithm
(Private_Key, stringToSign)
stringToSign = client ID + “|” + X-TIMESTAMP
Request Access Token Body
Parameter
Type
Required
Description
grantType 
String
Mandatory
Only “client_credentials”
additionalInfo
Object
Optional
﻿
Response Parameter
BI Parameter
NICEPAY Parameter
Type
Length
Required
Description
responseCode
responseCd
String
﻿
Optional
﻿General Response Code and Message - API SNAP﻿﻿
﻿
Error code to specify {{th}} error returned.
responseMessage
responseMsg
String
﻿
Optional
Response Message
﻿
Debug message to provide more 
accessToken
﻿
String
2048
Mandatory
A string representing authorization issued by Client uses to access protected resources
tokenType
﻿
  String
﻿
Mandatory
Token Type Value: “Bearer”
expiresIn
﻿
String
﻿
Mandatory
Session expiry in seconds: 900 
(15 minutes)
Sample Parameter
Sample Request
Sample Response
//HEADER SECTION
Content-Type: application/json
X-SIGNATURE: aFHq5SNdWO5Pq2vwZk4ztd9Cu3OvblG6NezGwLX3GC2mRJorDHPeZpR3V+RXrPC8ojcyCwQy01FSipmA8YdQvz1hOth7aekXzhigYCRNS34EHYEoFGD1YMHVFRvxn2Fu8HAd6wTvPNy2X2rbUS3hWrJsfa5cHu8wKVb7zPCuxNc=
X-CLIENT-KEY : NORMALTEST
X-TIMESTAMP: 2024-12-31T10:11:40+07:00

{
    "grantType": "client_credentials"
    "additionalInfo": {
 }
}
//HEADER SECTION
Content-Type: application/json
X-SIGNATURE: aFHq5SNdWO5Pq2vwZk4ztd9Cu3OvblG6NezGwLX3GC2mRJorDHPeZpR3V+RXrPC8ojcyCwQy01FSipmA8YdQvz1hOth7aekXzhigYCRNS34EHYEoFGD1YMHVFRvxn2Fu8HAd6wTvPNy2X2rbUS3hWrJsfa5cHu8wKVb7zPCuxNc=
X-CLIENT-KEY : NORMALTEST
X-TIMESTAMP: 2024-12-31T10:11:40+07:00

{
    "grantType": "client_credentials"
    "additionalInfo": {
 }
}
﻿
﻿

Service Code	API SNAP Service Code
API Endpoint	/nicepay/v1.0/access-token/b2b
HTTP Method	POST
Description	Request Token for Authentication
Content-type	application/json

Service Code	Reference API
73	E-Wallet - Access Token QRIS - Access Token
11	Balance Inquiry - API Payout (Disbursement) SNAP
54	Registration - API E-Wallet (Direct Debit) SNAP
55	Check Status Transaction - API E-Wallet (Direct Debit) SNAP
58	Refund Transaction - API E-Wallet (Direct Debit) SNAP
47	Registration - API QRIS SNAP
51	Check Status Transaction - API QRIS SNAP
78	Refund Transaction - API QRIS SNAP

Header Parameter Name	Type	Attribute	Content
Content-Type	String	Mandatory	Application/JSON
X-TIMESTAMP	String	Mandatory	YYYY-MM-DDTHH:MM:SS (2022-03-21T10:11:40+07:00)
X-CLIENT KEY	String	Mandatory	Provided (X-CLIENT KEY = CLIENT_ID)
X-SIGNATURE	String	Mandatory	Generated by / created using asymmetric signature SHA256withRSA algorithm (Private_Key, stringToSign) stringToSign = client ID + “\|” + X-TIMESTAMP

Parameter	Type	Required	Description
grantType	String	Mandatory	Only “client_credentials”
additionalInfo	Object	Optional

BI Parameter	NICEPAY Parameter	Type	Length	Required	Description
responseCode	responseCd	String		Optional	General Response Code and Message - API SNAP Error code to specify {{th}} error returned.
responseMessage	responseMsg	String		Optional	Response Message Debug message to provide more
accessToken		String	2048	Mandatory	A string representing authorization issued by Client uses to access protected resources
tokenType		String		Mandatory	Token Type Value: “Bearer”
expiresIn		String		Mandatory	Session expiry in seconds: 900 (15 minutes)

Refund QRIS

Payment API - SNAP

Request Access Token API - SNAP

About Request Access Token - SNAP

Request Access Token API - SNAP

Get Access Token

API SNAP Service Code

Get Header

Request Access Token Header

Request Access Token Body

Response Parameter

Sample Parameter

Welcome to NICEPAY DOCS