logo

搜索...

⌘ K

中文

产品文档
接口文档
资源下载
帮助中心

开始使用

总体概览

场景能力

接入步骤

收款能力

CKP 集成收银台页面

交互示意

集成准备

集成步骤

Deeplink 直跳方式

交互示意

集成准备

集成步骤

QRCode 展示二维码

交互示意

集成准备

集成步骤

付款能力

能力概述

充值入金

发起 U 提现/付款

发起法币提现

接收付款结果

支持的链和币种

支持的链

支持的币种

附录

钱包/币种/链

交易状态枚举值

支付状态

退款状态

提现状态

批量提现状态

错误码说明

签名算法

请求参数说明

请求方式

所有请求都是 POST 方式。

请求头参数

所有接口都需要在请求头中携带以下字段:

字段名 类型 必传 描述
content-type string 是 application/json
x-api-key string 是 Paydify提供,跟appId相同
x-api-timestamp string 是 时间戳,单位毫秒
x-api-signature string 是 签名,具体参看签名算法

代发子商户(Partner 凭据)

x-api-key 标识调用方凭据。使用商户自有凭据时,请求始终作用于该商户自身,无需额外字段。

合作伙伴(Partner)凭据可代已授权的子商户发起业务请求,此时需在业务接口的请求体中传入以下字段:

字段名 类型 必传 描述
merchantId string 条件必填 订单归属的子商户 ID。Partner 凭据代发时必填;商户自有凭据可不传,默认归属凭据所属商户
merchantAppId string 条件必填 归属商户下的应用 ID,与请求头 x-api-key(调用方凭据自身的 appId)不是同一个值。仅当凭据覆盖该商户多个应用时必填;仅一个授权应用时系统自动匹配

传入未授权的商户会被拒绝。相关错误码:MERCHANT_ID_REQUIRED、MERCHANT_APP_ID_REQUIRED、MERCHANT_GRANT_INVALID、MERCHANT_STATE_INVALID,参看错误码。

响应头参数

所有接口都会在响应头中携带以下字段:

字段名 类型 必传 描述
x-api-key string 是 Paydify提供,跟appId相同
x-api-timestamp string 是 时间戳,单位毫秒
x-api-signature string 是 签名,具体参看签名算法

返回值

所有接口返回值的数据结构如下:

{
  "code": "SYS_SUCCESS",
  "message": null,
  "messageDetail": null,
  "data": {},
  "success": true
}

返回值字段说明

字段名 类型 描述
code string 响应码,SYS_SUCCESS表示成功
message string 响应消息
messageDetail string 响应消息详情
data object 业务数据
success boolean 是否成功

目录