Apply Token

ApplyToken

POST https://mapi.yuansfer.com/auto-debit/v3/apply-token

The apply-token interface is used to recieve an AccessToken or refresh your current AccessToken.

Request Body

Name	Type	Description
merchantNo*	string	Merchant ID
storeNo*	string	Store ID
autoDebitNo*	string	The auto-debit record ID.
grantType*	string	Possible value are 'AUTHORIZATION_CODE', 'REFRESH_TOKEN'.
verifySign*	string	The parameter signature.

200 Correct return value :

{
    "result": {
        "accessTokenExpiryTime": "2021-07-07T03:17:31+08:00",
        "autoDebitNo": "298222562856331071",
        "autoReference": "testAuth2021010801",
        "vendor": "GCASH",
        "refreshTokenExpiryTime": "2022-01-08T03:17:31+08:00"
    },
    "ret_code": "000100",
    "ret_msg": "apply success"
}

Response

Parameter	Type	Description
result	object	The result object.
ret_msg	string	The response return message.
ret_code	string	The response return code. For more details, see here.

Result Object

Parameter	Type	Description
accessTokenExpiryTime	string	Expiry time of access token.
autoDebitNo	string	Unique ID of auto debit record in Yuansfer's system.
autoReference	string	Unique ID of auto debit in the merchant's system.
vendor	string	The possible payment channels are "gcash", "kakaopay", "alipay", "alipay_hk", "dana", "truemoney", "tng", "easypaisa", "bkash".
refreshTokenExpiryTime	string	Expiry time of refresh token.

Parameter format

{
    "merchantNo": "200043",
    "storeNo": "300014",
    "verifySign": "edeb2fe1c1be1c4d4763ac7b7c3a4098",
    "autoDebitNo": "298222562856331071",
    "grantType": "AUTHORIZATION_CODE"
}

Correct return value

{
    "result": {
        "accessTokenExpiryTime": "2021-07-07T03:17:31+08:00",
        "autoDebitNo": "298222562856331071",
        "autoReference": "testAuth2021010801",
        "vendor": "GCASH",
        "refreshTokenExpiryTime": "2022-01-08T03:17:31+08:00"
    },
    "ret_code": "000100",
    "ret_msg": "apply success"
}

Error return value

{
   "ret_code": "000000",
   "retMsg": "data error : verifySign",
}