API 接口文档

FaTPay 通过一系列 API 接口，为更多复杂场景提供服务

API 接口目前仅限高级合作伙伴调用，详情参见 如何成为高级合作伙伴。

成为高级合作伙伴后，您将获得专属的 partnerId 和密钥，用于 API 接口的调用。

API 接口列表

• 加密货币查询接口

  • 查询 FaTPay 当前支持的所有加密货币列表；

• 法定货币及支付方式查询接口

  • 查询 FaTPay 当前支持的所有法定货币及支持的支付方式；

• 报价查询接口

  • 基于输入的法定货币金额查询当前加密货币报价；

• 订单列表查询接口

  • 基于订单起止时间查询订单列表；

• 订单回调通知

  • 订单状态变更时，FaTPay 对合作伙伴服务端发起异步通知；

API 调用规范

请阁下务必遵照以下规范调用 FaTPay API 接口。

请求域名

https://api.ramp.fatpay.xyz/

请求协议

Protocol	Method	Content-Type
HTTPS	GETPOST	application/jsonmultipart/form-data

FaTPay API 接口仅支持 HTTPS 安全连接。

字符编码

UTF-8

公共 header 参数

调用 FaTPay API 接口，必须在每个 API 请求的 header 里加入以下参数。

参数名称及参数值均为大小写敏感

参数名	类型	含义
X-Fp-Partner-Id	String	申请成为高级合作伙伴时，由 FaTPay 分配的 partner ID，如：mqMBpCIP630LJxLY
X-Fp-Nonce	Integer(6)	随机正整数，如：183216
X-Fp-Timestamp	Integer(10)	Unixtime 时间戳，秒级，如：1656600459
X-Fp-Version	String	FaTPay API 接口版本，如：v1.0
X-Fp-Signature	String	基于请求参数和分配给高级合作伙伴的密钥，生成的签名，具体算法详见接口加签 & 验签

接口返回

API 接口正常都将返回错误码 code，错误消息 msg，以及数据部分 data。只有当 code 非 10000 时，data 部分都为空。数据部分 data 可能是一个对象 Object，也可能是一个数组 Array。视具体接口而定。

接口返回错误码及相应错误消息，参见API 接口错误码索引。

参数名	类型	是否必填	备注
code	String	是	错误码
msg	String	是	错误消息
data	Object	否	可能是对象或数组

接口返回示例

// 返回 data 为对象
{
  "code": "10000",
  "msg": "success",
  "data": {
    "foo": "bar"
  }
}

// 返回 data 为数组
{
  "code": "10000",
  "msg": "success",
  "data": [
    {
      "foo": "bar1"
    },
    {
      "foo": "bar2"
    }
  ]
}

// 返回 data 为空
{
  "code": "10002",
  "msg": "incorrect params",
  "data": null
}