开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
公域
营销
资金
会员
支付宝身份验证
app 支付宝登录
获取会员信息
接入指南
api 列表
用户信息
用户授权
人脸认证
信用
安全
广告
小程序云
其他
api文档 >  >  >  >  > 换取授权访问令牌接口
收藏
订阅更新
我的文档
设置

接口说明

接口英文名称:alipay.system.oauth.token
请求url:https://openapi.alipay.com/v3/alipay/system/oauth/token
请求方式:post
path指该参数为路径参数
query指该参数需在请求url传参
body指该参数需在请求json传参
换取授权访问令牌

公共请求参数

参数类型是否必选最大长度描述示例值
authorizationstring必选1024
请求身份信息,参考验签规则。在header参数中传递
content-typestring可选32
报文内容格式,默认需要使用application/json,加密请求使用text/plain,参考请求规则。在header参数中传递
application/json
x-http-method-overridestring可选16
http方法,对于部分不支持put、patch、delete等操作的情况,可以使用post发送请求,并通过该参数传输实际需要使用的http method,参考请求规则。在header参数中传递
put
alipay-request-idstring可选32
调用方的requestid,用于定位一次请求,需要每次请求保持唯一。排查问题时可以提供该字段,参考请求规则。在header参数中传递。
0ba7cddb1665744697169391253118
alipay-encrypt-typestring可选16
加密算法,请求使用加密能力时,需要指定加密算法,参考加解密规则。在header参数中传递
aes
alipay-root-cert-snstring可选128
支付宝根证书序列号。证书模式时,可传入该参数,支付宝服务端会校验序列号,确保调用方的证书未被篡改,参考验签规则。在header参数中传递
687b59193f3f462dd5336e5abf83c5d8_02941eef3187dddf3d3b83462e1dfcf6
alipay-app-auth-tokenstring可选128
应用授权令牌,参考代调用规则。在header参数中传递
201509bbeff9351ad1874306903e96b91d248a36

业务请求参数

body参数
grant_type|授权方式必选string[1,20]
【描述】授权方式
【枚举值】
用授权码来换取授权令牌: authorization_code
用刷新令牌来换取一个新的授权令牌: refresh_token
【示例值】authorization_code
code|授权码可选string[0,40]
【描述】授权码,用户对应用授权后得到。本参数在 grant_type 为 authorization_code 时必填;为 refresh_token 时不填。
【示例值】4b203fe6c11548bcabd8da5bb087a83b
refresh_token|刷新令牌可选string[0,40]
【描述】刷新令牌,上次换取访问令牌时得到。本参数在 grant_type 为 authorization_code 时不填;为 refresh_token 时必填,且该值来源于此接口的返回值 app_refresh_token(即至少需要通过 grant_type=authorization_code 调用此接口一次才能获取)。
【示例值】201208134b203fe6c11548bcabd8da5bb087a83b
常见请求示例
curl -x post \
 "https://openapi.alipay.com/v3/alipay/system/oauth/token" \
 -h "authorization: alipay-sha256withrsa app_id=${appid},timestamp=${now},nonce=${uuid},expired_seconds=600,sign=${sign}" \
 -h "alipay-request-id: ${requestid}" \
 -h "content-type: application/json" \
 -d '{
	"refresh_token":"201208134b203fe6c11548bcabd8da5bb087a83b",
	"code":"4b203fe6c11548bcabd8da5bb087a83b",
	"grant_type":"authorization_code"
}'
说明:本示例仅供参考。

公共响应参数

参数中文名参数英文名类型是否必选最大长度描述示例值
支付宝响应时间戳alipay-timestampstring可选32
unix时间戳,用于验签及问题排查,参考验签规则。在header参数中传递
1666004496123
支付宝响应签名alipay-signaturestring可选512
支付宝响应报文签名,参考验签规则。在header中返回
支付宝traceidalipay-traceidstring可选64
支付宝traceid ,用于排查问题使用,参考请求规则。在header中返回
0ba7cddb1665744697169391253118
支付宝随机串alipay-noncestring可选64
支付宝nonce标记,每次请求会生成不同的nonce,可用于防重放判断,参考请求规则。在header中返回
515cf24c2f78b13564e94c2a495695ab

业务响应参数

access_token|访问令牌必选string(40)
【描述】访问令牌。通过该令牌调用需要授权类接口
【示例值】20120823ac6ffaa4d2d84e7384bf983531473993
expires_in|访问令牌有效期必选string(16)
【描述】访问令牌的有效时间,单位是秒。
【示例值】3600
refresh_token|刷新令牌必选string(40)
【描述】刷新令牌。通过该令牌可以刷新access_token
【示例值】20120823ac6ffdsdf2d84e7384bf983531473993
re_expires_in|刷新令牌有效时间必选string(16)
【描述】刷新令牌的有效时间,单位是秒。
【示例值】3600
以下参数 二选一 
user_id|支付宝用户的唯一标识。以2088开头的16位数字。string(16)
【描述】支付宝用户的唯一标识。以2088开头的16位数字。
新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看openid配置申请
【示例值】2088102150477652
open_id|支付宝用户唯一标识string(128)
【描述】支付宝用户唯一标识  详情可查看 openid简介
【示例值】074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5
auth_start|授权开始时间可选date(32)
【描述】授权token开始时间,作为有效期计算的起点
【示例值】2010-11-11 11:11:11
响应示例
{
	"user_id":"2088102150477652",
	"open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
	"access_token":"20120823ac6ffaa4d2d84e7384bf983531473993",
	"expires_in":"3600",
	"refresh_token":"20120823ac6ffdsdf2d84e7384bf983531473993",
	"re_expires_in":"3600",
	"auth_start":"2010-11-11 11:11:11"
}
说明:本示例仅供参考。

公共错误码

前往查看

业务错误码

状态码错误码错误描述凯发app官方网站的解决方案
400isp.unknow-error未知错误
重试,或联系支付宝客服
400isv.code-invalid授权码(auth_code)
错误、状态不对或过期
使用有效的auth_code重新执行令牌换取,或引导用户重新授权
400isv.grant-type-invalidgrant_type参数不正确
grant_type必须是authorization_code、refresh_token二者之一 若传入authorization_code为code换取令牌,若传入refresh_token为刷新令牌
400isv.refresh-token-invalid刷新令牌(refresh_token)错误或状态不对
使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权
400isv.refresh-token-time-out刷新令牌(refresh_token)过期
使用有效的refresh_token重新执行令牌刷新,或引导用户重新授权
400isv.refreshed-token-invalid刷新出来的令牌无效
使用返回的刷新令牌再次刷新
400isv.unmatched-app-id调用接口的应用标识(app_id)与令牌授权的应用不相符
传入正确的app_id和令牌,若开发者支付宝账号名下有多个app_id,或者开发者管理多个归属于不同支付宝账号的app_id,请注意不要混用不同app_id的code
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图