接口规范

ㅤ	ㅤ
通信方式	https • json
字符集	UTF-8
加密方式	使用 `RSA` 加密；使用 `base64` 签名
日期格式	yyyy-MM-dd
网络限制	IP 白名单

API 请求流程示例

--- config: theme: base sequence: useMaxWidth: true diagramMarginX: 20 diagramMarginY: 10 actorMargin: 45 width: 120 height: 40 messageMargin: 28 noteMargin: 8 mirrorActors: false wrap: true themeVariables: fontFamily: Arial, "PingFang SC", "Microsoft YaHei", sans-serif fontSize: 14px primaryColor: "#111827" primaryTextColor: "#FFFFFF" primaryBorderColor: "#111827" lineColor: "#64748B" signalColor: "#334155" signalTextColor: "#334155" noteBkgColor: "#F8FAFC" noteTextColor: "#334155" noteBorderColor: "#CBD5E1" activationBkgColor: "#E2E8F0" activationBorderColor: "#94A3B8" --- sequenceDiagram autonumber participant S as 付款方 participant P as 合作伙伴 participant X as UDOHR participant R as 收款方 rect rgb(248, 250, 252) Note over S,X: 阶段一：创建转账订单 S->>P: 提交收款信息及转账金额 P->>X: 查询汇率 Note right of P: POST /global/payout/rate/query/price X-->>P: 返回汇率及 queryNo P->>X: 创建转账订单 Note right of P: POST /global/payout/transfer/create X-->>P: 返回订单创建结果 end rect rgb(248, 250, 252) Note over S,X: 阶段二：上传交易材料 S->>P: 上传交易证明文件 loop 每个文件 P->>X: 分片或多文件上传 Note right of P: POST /global/payout/transfer/upload/multipart X-->>P: 返回文件上传结果 end P->>X: 确认文件上传完成 Note right of P: POST /global/payout/transfer/upload/completed X-->>P: 返回材料接收结果 end rect rgb(248, 250, 252) Note over S,X: 阶段三：预检查与付款确认 activate X X->>X: 执行订单及 AML 预检查 X-->>P: 返回订单状态 deactivate X P-->>S: 展示订单信息并请求确认 alt 信息正确 S->>P: 确认转账 else 信息有误 S->>P: 修改转账信息 P->>X: 更新或重新创建订单 X-->>P: 返回更新结果 end end rect rgb(248, 250, 252) Note over P,R: 阶段四：确认执行与资金下发 Note over S,P: 合作伙伴已完成付款方 KYC、AML 等内部检查 P->>X: 提交转账确认 Note right of P: POST /global/payout/transfer/aysnc X-->>P: 受理成功 activate X X->>X: 检查合作伙伴账户余额 alt 余额充足且订单审核通过 X->>R: 执行资金付款 R-->>X: 返回入账结果 X-->>P: 更新最终状态 P-->>S: 通知转账结果 else 余额不足或审核失败 X-->>P: 返回失败状态及原因 P-->>S: 通知失败结果 end deactivate X end

安全说明

使用本 API 前，您需要获取相应凭证。我们将使用这些凭证识别并授权您访问 Pay Out API。

💡

请联系 dev@udohr.com 获取凭证。开始使用 API 前，您应从我们处获取以下凭证。

名称	说明
App Key	用于在调用 API 时识别您的身份，并获取用于访问受限资源的授权 token。
Secret Key	用于获取访问受限资源所需的授权 token。

请求头

开始使用 API 前，请按以下要求设置请求头属性。

名称	说明
appkey	必填，由 UDOHR 提供。
token	必填，通过授权 API 获取。
sign	必填，基于请求体内容字符串进行加密生成。

请求体

Content-Type 为 application/json

API Hosts

sandbox：https://api-sandbox.udohr.com

production：https://api.udohr.com

生成私钥

💡

计算机系统环境需支持 OpenJDK 8 或更高版本，并下载通过邮件发送给您的文件。

OpenSecretToolForWin.zip

54331.7KB

下载并解压文件后，在文件夹中点击 secret.jar 打开 GUI 工具，生成私钥和公钥。请将公钥发送给 UDOHR，并自行妥善保管私钥。

加密方式

💡

加密：使用私钥对数据进行加密（需先将请求体转换为 JSON 字符串，然后使用私钥加密，最后获取 base64 字符串并放入请求头。具体可参考通过邮件发送给您的 Java 示例代码。）

Java 代码示例

java
import com.tratao.jcommon.common.BaseServiceException;
import org.apache.commons.codec.binary.Base64;
import org.apache.commons.io.IOUtils;
import org.springframework.stereotype.Component;

import javax.crypto.Cipher;
import java.io.ByteArrayOutputStream;
import java.security.*;
import java.security.interfaces.RSAPrivateKey;
import java.security.interfaces.RSAPublicKey;
import java.security.spec.PKCS8EncodedKeySpec;
import java.security.spec.X509EncodedKeySpec;

public class RsaUtil {

	public static final String CHARSET = "UTF-8";
	public static final String RSA_ALGORITHM = "RSA";
	public static final String RSA_ALGORITHM_SIGN = "SHA256WithRSA";
	
	/**
	* sign data
	* @param data the string value
	* @param privateKeyStr private key 
	* @return
	*/
	public String sign(String data,String privateKeyStr){
	  try{
	      //sign
	      KeyFactory keyFactory = KeyFactory.getInstance(RSA_ALGORITHM);
	      PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(Base64.decodeBase64(privateKeyStr));
	      privateKey = (RSAPrivateKey) keyFactory.generatePrivate(pkcs8KeySpec);
	      Signature signature = Signature.getInstance(RSA_ALGORITHM_SIGN);
	      signature.initSign(privateKey);
	      signature.update(data.getBytes(CHARSET));
	      return Base64.encodeBase64URLSafeString(signature.sign());
	  }catch(Exception e){
	      throw new RuntimeException("sign data: [" + data + "] throw exception", e);
	  }
	}
	
	/**
	 * decrypt data
	 * @param data sign data
	 * @param privateKeyStr private key
	 * @return
	 */
	public String privateDecrypt(String data,String privateKeyStr){
	    try{
	        KeyFactory keyFactory = KeyFactory.getInstance(RSA_ALGORITHM);
	        PKCS8EncodedKeySpec pkcs8KeySpec = new PKCS8EncodedKeySpec(Base64.decodeBase64(privateKeyStr));
	        privateKey = (RSAPrivateKey) keyFactory.generatePrivate(pkcs8KeySpec);
	        Cipher cipher = Cipher.getInstance(RSA_ALGORITHM);
	        cipher.init(Cipher.DECRYPT_MODE, privateKey);
	        return new String(rsaSplitCodec(cipher, Cipher.DECRYPT_MODE, Base64.decodeBase64(data), privateKey.getModulus().bitLength()), CHARSET);
	    } catch(Exception e){
	        throw new RuntimeException("decrypt sign data: [" + data + "] throw exception", e);
	    }
	}
}

Java SDK

⏳

即将推出

合作伙伴集成检查清单

该检查清单用于协助新合作伙伴完成 API 集成、开发和测试。

事项	说明
生产环境需加入白名单的 IP	例如：111.222.333.444
接收加密生产环境 API_KEY 和 SFTP 账号的 POC 邮箱地址。	例如：dev@udohr.com

开发指南