Access Token

Access Token API is an API call that can be used to acquire B2B access token. This access token will be used to access subsequent Transactional API such as payment, refund, query, etc.

Merchant server collects access token by calling ShopeePay system.
ShopeePay will generate the access token and return the token to Merchant.
Access token has validity period, once it passes the validity period client need to collect a new access token.
Merchant can access Transactional API by sending access token on API header.

Specification

The following table is a specification of this API:

HTTP Method	POST
Service Code	73
Path	.../v1.0/access-token/b2b
Version	v1.0

Request Parameters

Field	Type	Mandatory	Description
grantType	String	M	Grant Type Value: “client_credentials”

Sample API Request

REQUEST

{
   "grantType":"client_credentials"
}

Copy

Response Parameters

Field	Type	Mandatory	Description
responseCode	String	M	Error code to specify the error returned.
responseMessage	String	M	Debug message to provide more information.
accessToken	String	M	A string representing an authorization issued to the client that used to access protected resources.
tokenType	String	M	Token Type Value: “Bearer”
expiresIn	String	M	Session expiry in seconds. (default = 900 seconds or 15 minutes)

Sample API Response

RESPONSE

{
  "responseCode": "2007300",
  "responseMessage": "Successful",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDbGllbnRJRCI6Ik1IMjAyMjA3MDhCIiwiZXhwIjoxNjU4NzIwOTk5NjY5LCJpYXQiOjE2NTg3MTczOTk2NjksImlzcyI6Ik1IMjAyMjA3MDhCIiwibmJmIjoxNjU4NzE3Mzk5NjY5fQ.hv0dubKQTeTR4n2VK_qzf8N3MPUv1wEc8LiMa1eglVc",
  "tokenType": "Bearer",
  "expiresIn": "900"
}