跳转到主要内容
POST
/
v2
/
payments
/
open
/
api
/
transfer
/
query
付款查询
curl --request POST \
  --url https://gate.uat.payloco.com/gateway/v2/payments/open/api/transfer/query \
  --header 'Content-Type: application/json' \
  --header 'signature: <api-key>' \
  --data '
{
  "charset": "UTF-8",
  "version": "2.0.0",
  "signType": "RSA",
  "memberId": "2023010558663764",
  "merchantId": "2023010558663764",
  "requestTime": "2026-05-24T14:29:32.682+08:00",
  "keyVersion": "1",
  "data": {
    "merchantOrderId": "1780673140561",
    "orderId": "1929851221343618"
  }
}
'
{
  "code": "00000003",
  "message": "处理中",
  "traceId": "33fae7b7aed1233f",
  "data": {
    "merchantId": "2023010558663764",
    "merchantOrderId": "20230105586637641001",
    "status": "PENDING",
    "createTime": "2025-01-31T06:57:10+0000",
    "completeTime": "2025-01-31T06:57:10+0000",
    "orderId": "TR1654005852065107968",
    "resultCode": "string",
    "resultMsg": "string",
    "trade": {
      "amount": 10.01,
      "currency": "USD"
    }
  }
}

授权

signature
string
header
必填

加签(Signature)

加签是 PayLoco 开放平台与商户之间用于保障报文完整性防篡改的安全机制。

适用场景

  1. 商户请求 PayLoco:商户使用自身私钥对请求报文进行加签。
  2. PayLoco 返回响应:商户使用 PayLoco 公钥 对响应报文进行验签。

加签规则(商户请求端)

商户需对 HTTP 请求的 Body 进行签名,具体步骤如下:

1. 计算签名(SHA256withRSA)

Signature signature = Signature.getInstance("SHA256withRSA");
signature.initSign(merchantPrivateKey);

// 必须使用 UTF-8 编码
byte[] bodyBytes = requestBody.getBytes(StandardCharsets.UTF_8);
signature.update(bodyBytes);

byte[] signedBytes = signature.sign();

2. 将加签内容进行 Base64 编码;

String signature = Base64.getEncoder().encodeToString(signedHash);

3. 将编码后的内容放在请求头部 signature 参数中。

POST /v2/payments/open/api/pay HTTP/1.1
Content-Type: application/json
signature: MIIC8jCCAdqgAwIBAgI...

请求体

application/json

请求数据体

charset
string
默认值:UTF-8
必填

交互数据的编码【utf-8】

示例:

"UTF-8"

version
string
必填

接口版本,当前版本为【2.0.0】,目前只能传2.0.0,不能不传

Maximum string length: 8
示例:

"2.0.0"

signType
string
必填

报文签名类型

示例:

"RSA"

memberId
string
必填

机构号

示例:

"2023010558663764"

merchantId
string
必填

商户号

Maximum string length: 32
示例:

"2023010558663764"

requestTime
string
必填

请求时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ssSSS+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2026-05-20T13:29:35.262+08:00表示,北京时间2026年5月20日13点29分35秒。

Maximum string length: 32
示例:

"2026-05-24T14:29:32.682+08:00"

keyVersion
string
必填

密钥版本 当前值为:1

Maximum string length: 8
示例:

"1"

data
object

请求数据体

响应

200 - application/json

OK

code
string
必填

响应状态码,code为00000000表示响应成功,其他状态码表示响应失败。具体系统错误码可以参考系统错误码。

示例:

"00000003"

message
string
必填

错误消息

示例:

"处理中"

traceId
string
必填

请求消息唯一标识。traceId为本次调用产生的流水号,接口调用异常,可以提供此流水号用于排查问题。

示例:

"33fae7b7aed1233f"

data
object