Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
新版服务端API(DingTalk OpenAPI)
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取访问凭证通讯录应用市场客户管理服务群考勤待办任务日程钉盘会议专属钉钉合作空间钉工牌数据目录制造业数字化管理师宜搭应用开发文档
获取访问凭证通讯录应用市场客户管理服务群考勤待办任务日程钉盘会议专属钉钉合作空间钉工牌数据目录制造业数字化管理师宜搭应用开发文档
  1. 使用SuiteAccessToken调用
  • 使用AccessToken调用
    • 创建钉工牌电子码
      POST
    • 更新钉工牌电子码
      PUT
    • 解码钉工牌电子码
      POST
    • 通知支付结果
      POST
    • 通知退款结果
      POST
    • 同步钉工牌码验证结果
      POST
    • 配置企业钉工牌
      POST
  • 使用SuiteAccessToken调用
    • 创建钉工牌电子码
      POST
    • 更新钉工牌电子码
      PUT
    • 解析钉工牌电子码
      POST
    • 通知支付结果
      POST
    • 通知退款结果
      POST
    • 同步钉工牌码验证结果
      POST
    • 配置企业钉工牌
      POST
  1. 使用SuiteAccessToken调用

通知支付结果

POST
http://127.0.0.1/v1.0/finance/payCodes/pay/notify
新版服务端API(DingTalk OpenAPI)/钉工牌/使用SuiteAccessToken调用
最后修改时间:2022-08-30 09:19:23
责任人:未设置

说明#

用户支付完成后,可调用本接口同步支付结果,并通知用户完成消费,同时为用户记录账单。
服务地址:api.dingtalk.com

权限#

要调用此API,需要以下权限之一。
应用类型是否支持权限API Explorer调试
企业内部应用暂不支持钉钉付款码信息写权限暂不支持
第三方企业应用支持钉钉付款码信息写权限API Explorer
第三方个人应用暂不支持钉钉付款码信息写权限暂不支持

错误码#

HttpCode错误码错误信息说明
500unknownError未知错误未知错误

请求参数

Header 参数
x-acs-dingtalk-access-token
string 
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
payCode
string 
必需
付款码值,用户扫码支付的码值。
corpId
string 
必需
企业的corpId。
userId
string 
必需
用户的userid,需要与创建码时的userid保持一致。
gmtTradeCreate
string 
必需
交易开始时间。格式:yyyy-MM-dd HH:mm:ss。
gmtTradeFinish
string 
必需
交易结束时间。格式:yyyy-MM-dd HH:mm:ss。
tradeNo
string 
必需
交易号,调用方生成的交易号。
tradeStatus
string 
交易状态,取值。
必需
title
string 
订单标题。
必需
remark
string 
备注。
必需
amount
string 
订单金额。
必需
promotionAmount
string 
必需
订单优惠金额,如果没有传0.00。
chargeAmount
string 
收费金额。
必需
payChannelDetailList
array [object {8}] 
支付渠道明细信息。
必需
payChannelName
string 
支付渠道名称。
必需
gmtCreate
string 
可选
开始时间。格式:yyyy-MM-dd HH:mm:ss。
gmtFinish
string 
可选
结束时间。格式:yyyy-MM-dd HH:mm:ss。
payChannelType
string 
必需
支付渠道类型,取值。
amount
string 
支付金额。
必需
payChannelOrderNo
string 
支付渠道单号。
必需
promotionAmount
string 
优惠金额。
必需
fundToolDetailList
array [object {6}] 
资金工具明细。
必需
tradeErrorCode
string 
可选
支付失败错误码,当tradeStatus为FAIL时必须传入。
tradeErrorMsg
string 
可选
支付失败信息,当tradeStatus为FAIL时必须传入。
extInfo
string 
扩展信息。
可选
merchantName
string 
商户名称。
必需
示例
{}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/v1.0/finance/payCodes/pay/notify' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body
result
string 
处理结果,取值:
可选
示例
{
  "result": "string"
}
上一页
解析钉工牌电子码
下一页
通知退款结果
Built with