换取授权访问令牌
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.system.oauth.token |
format | String | 可选 | 40 | 仅支持JSON | JSON |
charset | String | 必选 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 必选 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 必选 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
app_auth_token | String | 可选 | 40 | 详见应用授权概述 |
请求参数
参数中文名 | 参数英文名 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|---|
授权方式 | grant_type | String | 必选 | 20 | 授权方式枚举值用授权码来换取授权令牌: authorization_code用刷新令牌来换取一个新的授权令牌: refresh_token | authorization_code |
授权码 | code | String | 可选 | 40 | 授权码,用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填;为 refresh_token 时不填。 | 4b203fe6c11548bcabd8da5bb087a83b |
刷新令牌 | refresh_token | String | 可选 | 40 | 刷新令牌,上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填;为 refresh_token 时必填,且该值来源于此接口的返回值 app_refresh_token(即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取)。 | 201208134b203fe6c11548bcabd8da5bb087a83b |
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见文档 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数中文名 | 参数英文名 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|---|
支付宝用户的唯一标识。以2088开头的16位数字。 | user_id | String | 必选 | 16 | 支付宝用户的唯一标识。以2088开头的16位数字。想了解openid? | 2088102150477652 |
访问令牌 | access_token | String | 必选 | 40 | 访问令牌。通过该令牌调用需要授权类接口 | 20120823ac6ffaa4d2d84e7384bf983531473993 |
访问令牌有效期 | expires_in | String | 必选 | 16 | 访问令牌的有效时间,单位是秒。 | 3600 |
刷新令牌 | refresh_token | String | 必选 | 40 | 刷新令牌。通过该令牌可以刷新access_token | 20120823ac6ffdsdf2d84e7384bf983531473993 |
刷新令牌有效时间 | re_expires_in | String | 必选 | 16 | 刷新令牌的有效时间,单位是秒。 | 3600 |
授权开始时间 | auth_start | Date | 可选 | 32 | 授权token开始时间,作为有效期计算的起点 | 2010-11-11 11:11:11 |
请求示例
响应示例
{
"alipay_system_oauth_token_response": {
"user_id": "2088102150477652",
"access_token": "20120823ac6ffaa4d2d84e7384bf983531473993",
"expires_in": "3600",
"refresh_token": "20120823ac6ffdsdf2d84e7384bf983531473993",
"re_expires_in": "3600",
"auth_start": "2010-11-11 11:11:11"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"error_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
错误码
公共错误码
业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
isv.grant-type-invalid | grant_type参数不正确 | grant_type必须是authorization_code、refresh_token二者之一 若传入authorization_code为code换取令牌,若传入refresh_token为刷新令牌 |
isv.code-invalid | 授权码(auth_code) 错误、状态不对或过期 | 使用有效的auth_code重新执行令牌换取,或引导用户重新授权 |
isv.refresh-token-invalid | 刷新令牌(refresh_token)错误或状态不对 | 使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权 |
isv.refresh-token-time-out | 刷新令牌(refresh_token)过期 | 使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权 |
isv.refreshed-token-invalid | 刷新出来的令牌无效 | 使用返回的刷新令牌再次刷新 |
isv.unmatched-app-id | 调用接口的应用标识(app_id)与令牌授权的应用不相符 | 传入正确的app_id和令牌,若开发者支付宝账号名下有多个app_id,或者开发者管理多个归属于不同支付宝账号的app_id,请注意不要混用不同app_id的code |
isp.unknow-error | 未知错误 | 重试,或联系支付宝客服 |