文档控制台
文档首页/
Paynicorn 支付/
API 文档/
付款产品/

付款产品

更新时间:2024.06.07 06:34:47

付款产品

代付 (Payout)

接口说明

对于已经结算至代付余额的金额,您可以通过代付接口实现转账或申请提现。

请注意:

接口地址

https://api.paynicorn.com/trade/v3/transaction/payout

接口参数

字段填写要求 M:mandatory 必填,O:optional 条件选填

字段名类型填写要求描述
orderIdString(64)M商户付款订单号
currencyString(3)M币种代码(CurrencyCode),参见附录国家币种对照表
amountString(32)M金额
countryCodeString(2)M国家代码(CountryCode),参见附录国家币种对照表
payoutMethodString(64)M转账类型(CARD,MTN,MPESA,PAYNICORNPAY,AIRTEL...)
nameString(64)M收款人名字
accountString(64)M收款账户
bankCodeString(64)O银行码(转账类型为银行卡时必填)参见附录银行代码

响应参数

字段名类型填写要求备注
codeString(16)M状态码参见 状态码
messageString(256)M消息参见 状态码
statusString(2)M订单状态(-1:处理中;0:失败)
txnIdString(64)O交易单号

报文示例

Request Body

{
        "account": "2254630776",
        "amount": "100",
        "appKey": "70kP76p4j3894oNO926h",
        "bankCode": "NG037", // 银行映射表
        "countryCode": "NG",
        "currency": "NGN",
        "name": "zhang zhongming",
        "orderId": "12428512966672483",
        "payoutMethod": "CARD"
}

Response

{
        "code": "0000",
        "message": "success",
        "status": "-1", //-1: 退款处理中,1: 退款成功,0:退款失败
        "txnId": "62428512966672847"
}

查询交易结果接口 (Query)

接口说明

对于无法及时获得 API 调用结果与 API 调用超时的场景,您可以通过本 API 查询最新的结果。

接口地址

https://api.paynicorn.com/trade/v3/transaction/query

请求参数

字段填写要求 M:mandatory 必填,O:optional 条件选填

字段名类型填写要求描述
orderIdString(64)M商户订单号
txnTypeString(8)M交易类型

响应参数

字段名类型填写要求备注
codeString(16)M状态码参见 状态码
messageString(256)M消息参见 状态码
txnIdString(64)M交易单号
statusString(4)M支付结果
completeTimeString(16)O交易处理完成时间

报文示例

Request Body

{
        "appKey": "7971100",
        "orderId": "92428512966672483",
        "txnType": "payout"
}

Response

{
        "code": "0000",
        "completeTime": "",
        "message": "success",
        "status": "-1", //-1: 支付处理中,1: 支付成功,0:支付失败
        "txnId": "32428513799242015"
}