文档

执行付款

创建付款

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payment/create

生产环境请求地址：POST https://api.futurepay.global/api/v1/payment/create

字段说明

请求参数

字段名称必填类型描述
merchantReferenceMstring商户请求流水号，不能重复
payeeIdMstring收款方id
paymentFeeTypeOstring手续费分摊方式，枚举类型 SHA、OUR、BEN
payerTypeMstring付款方类型(企业-company 个人-individual)
payerIdMstring该值为「商户—merchantId」或「创建的付款方——payerId」；
amountMBigdecimal付款金额
debitCcyMstring扣款币种
paymentPurposeCodeMstring付款目的编码(付款目的 参考)
phoneAreaCodeOstring手机号区号
phoneNumberOstring手机号
sourceOfFoundsOstring资金来源 Salary(工资) Personal Saving(个人储蓄) Personal Wealth(个人财富) Retirement Funds(退休基金) Business Owner/Shareholder(企业主/股东) Loan Facility(贷款资金) Personal Account(个人账户) Corporate Account(企业账户)
narrationOstring交易付言
quoteIdOstring交易汇率id 交易汇率为空使用实时汇率

响应data参数

字段名类型说明
merchantReferenceString商户请求流水号
pspReferenceStringfuturePay平台流水号
resultCodeString付款订单状态，创建(CREATE)、合规检查中（COMPLIANCE）、付款中(PENDING)、交易成功(SUCCESS)、交易失败(FAILED)、交易失败-已退回(RETURN)、交易失败-已召回(RECALL)
tradeRateString交易汇率（此汇率表示从扣款币种转换为付款币种的比值）
paymentAmount.currencystring扣款币种
paymentAmount.valuestring扣款金额
payeeAmount.currencystring付款币种
payeeAmount.valuestring付款金额
feeAmount.currencystring手续费币种
feeAmount.valuestring手续费金额

集成

创建付款调用输入

{   
    "merchantReference":"000004c69635c0kcCCpp00ccdas",
    "payerId":"1864861460719644672",
    "payerType":"company",
    "paymentPurposeCode":"28",
    "amount":"200",
    "payeeId":"930",
    "narration":"test",
    "debitCcy":"USD",
    "phoneNumber":"987654321",
    "phoneAreaCode":"+123",
		"quoteId":"f79e44597bee4bb3b2bde461ae379df1",
    "paymentFeeType":"SHA"
}

调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1744079376875,
    "data": {
        "merchantReference": "000004c69635c0kcCCpp00ccdas",
        "pspReference": "MP680929594109952",
        "resultCode": "CREATE",
        "tradeRate": null,
        "paymentAmount": {
            "currency": "USD",
            "value": "204"
        },
        "payeeAmount": {
            "currency": "USD",
            "value": "200"
        },
        "feeAmount": {
            "currency": "USD",
            "value": "4"
        }
    },
    "success": true
}

查询付款状态

端点目标 URL

沙盒环境请求地址：POST https://preapi.futurepay-develop.com/api/v1/payment/get-payment-status

生产环境请求地址：POST https://api.futurepay.global/api/v1/payment/get-payment-status

字段说明

请求参数

字段名称必填类 型描述
merchantReferenceMstring创建付款时商户提交的请求流水号

响应data参数

字段名类型说明
merchantReferenceString商户请求流水号
pspReferenceStringfuturePay平台流水号
resultCodeString付款订单状态，创建(CREATE)、合规检查中（COMPLIANCE）、付款中(PENDING)、交易成功(SUCCESS)、交易失败(FAILED)、交易失败-已退回(RETURN)、交易失败-已召回(RECALL)
tradeRateString交易汇率（此汇率表示从扣款币种转换为付款币种的比值）
paymentAmount.currencystring扣款币种
paymentAmount.valuestring扣款金额
payeeAmount.currencystring付款币种
payeeAmount.valuestring付款金额
feeAmount.currencystring手续费币种
feeAmount.valuestring手续费金额
returnAmount.currencystring退回金额币种
returnAmount.valuestring退回金额
discountFeeAmount.currencystring召回手续费金额币种
discountFeeAmount.value string召回手续费金额

集成

查询付款状态调用输入

{   
    "merchantReference":"000004c69635c0kcCCpp00ccdas"
}

调用输出

{
    "code": "0",
    "msg": "succeeded",
    "serverTime": 1744079430062,
    "data": {
        "merchantReference": "000004c69635c0kcCCpp00ccdas",
        "pspReference": "MP680929594109952",
        "resultCode": "COMPLIANCE",
      	"tradeRate":null,
        "paymentAmount": {
            "currency": "USD",
            "value": "204"
        },
        "payeeAmount": {
            "currency": "USD",
            "value": "200"
        },
        "feeAmount": {
            "currency": "USD",
            "value": "4"
        },
        "returnAmount": {
            "currency": null,
            "value": null
        },
        "discountFeeAmount": {
            "currency": null,
            "value": null
        }
    },
    "success": true
}

WEBHOOK

{
    "appId":"1864861460728012800",
    "merchantId":"1864861460719644672",
    "notificationItems":[
        {
            "eventCode":"PAYMENT_ORDER_RESULT",
            "eventDate":1738834234129,
            "paymentAmount": {
                "currency": "USD",
                "value": "204"
            },
            "payeeAmount": {
                "currency": "USD",
                "value": "200"
            },
            "feeAmount": {
                "currency": "USD",
                "value": "4"
            },
            "returnAmount":{},
            "discountFeeAmount":{},
            "merchantReference": "000004c69635c0kcCCpp00ccdas",
            "pspReference":"MP659438116933632",
            "tradeRate":null,
            "resultCode":"SUCCESS"
        }
    ]
}