发起支付 - POST /api/(version)/payments/(token_address)/(target_address)
发起一个支付。只有当支付成功或失败后请求才会返回。支付可能由于多种原因而失败, 例如锁超时、目标不在线、通向目标的通道没有足够的结算超时和揭示超时设置值、 资金不足等。
API请求
POST /api/(version)/payments/(token_address)/(target_address)
URL参数:
- version:API版本号,目前可用:v1
- token_address:代币地址
- target_address:对方地址
BODY参数对象,主要包含以下字段:
- amount:要发送给对方的数量,整数
- identifier:本次支付的标识符,整数,可选
API响应
返回一个JSON对象,包含如下字段:
- initiator_address:发起地址
- target_address:目标地址
- token_address:代币地址
- amount:代币数量
- identifier:支付标识符
注册代币API的http响应代码可能为以下值:
- 200 OK – 支付成功
- 400 Bad Request – 请求参数格式不正确
- 402 Payment Required – 余额不足
- 404 Not Found – 指定的代币或对方地址不是有效的eip55以太坊地址
- 408 Request Timeout – 支付超时
- 409 Conflict – 地址或数量无效等原因
- 500 Internal Server Error – Raiden节点内部错误
示例代码
curl请求示例:
curl -i -X POST http://localhost:5001/api/v1/payments/0x2a65Aca4D5fC5B5C859090a6c34d164135398226/0x61C808D82A3Ac53231750daDc13c777b59310bD9 -H 'Content-Type: application/json' --data-raw '{"amount": 200, "identifier": 42}'
响应结果如下:
HTTP/1.1 200 OK
Content-Type: application/json
{
"initiator_address": "0xEA674fdDe714fd979de3EdF0F56AA9716B898ec8",
"target_address": "0x61C808D82A3Ac53231750daDc13c777b59310bD9",
"token_address": "0x2a65Aca4D5fC5B5C859090a6c34d164135398226",
"amount": 200,
"identifier": 42
}