Skip to content

申请付款

  • Endpoint: POST /aggregate-pay/api/gateway/paymentOrderPay
  • Tags: 付款

Description

此接口为API付款接口,该接口返回参数请注意以下事项,否则可能会有资损风险:

  1. 当"code": "APPLY_SUCCESS"且返回"status":"PENDING",代表下单成功,订单状态请以回调或查询接口status为准;
  2. 当"code": "ORDER_REPEAT",代表该outTradeNo已经下过单,请等待回调或查询接口确认订单状态,每次下单需确保outTradeNo唯一;
  3. 其他场景请检查参数后不换outTradeNo重新发起,注意重新设置requestTime;

Parameters

FieldTypeRequiredDescription
Content-Type (header)stringYes
sign (header)stringYes签名信息请参考技术文档

Request Body

FieldTypeRequiredDescription
versionstringYes接口版本 当前值为:1.5
keyVersionstringYes密钥版本 当前值为:1
requestTimestringYes请求时间,符合rfc3339规范,格式:yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appIdstringYes商户应用Id,PayerMax分配给商户应用的唯一标识
merchantNostringNo商户号,商户与PayerMax业务签约时生成的唯一标识
dataobjectYes请求数据体
data.outTradeNostringYes商户订单号,唯一标识商户的一笔交易,不能重复,只能包含字母、数字、下划线
data.countrystringYes国家代码,大写字母,参见【支持的国家与币种
data.chargeOptionstringNo费用承担模式,是否必传参照《付款申请模板及填写规范
data.clearingRailstringNo枚举值为:SWIFT, SEPA, LOCAL,分别对应签约的SWIFT、SEPA、Local Banks支付方式,请根据实际要用的支付方式来上送,请参照《付款申请模板及填写规范
data.userIdstringNo商户内部的用户Id,需要保证每个ID唯一性
data.sourceAccountstringNo扣款账户的币种代码,大写字母
data.destinationCurrencystringNo指定到账币种,请参考【支付方式列表】,如有标明到账币种的,需要指定到账币种;若未标明,则到账币种仅支持本币,不需要进行指定
data.tradeobjectYes交易信息
data.trade.amountstringYes交易金额 ,按照各国币种支持的小数点位上送。注意:印尼,越南,韩国,智利,本币不支持带小数金额
data.trade.currencystringYes交易币种,大写字母
data.payeeInfoobjectYes收款方信息
data.payeeInfo.paymentMethodTypestringYes支付方式,请参考【支付方式列表
data.payeeInfo.targetOrgstringNo目标机构,请参考【支付方式列表
data.payeeInfo.payeeType stringNo收款方类型(PERSONAL/CORPORATION),默认PERSONAL
data.payeeInfo.accountInfoobjectYes收款账户信息
data.payeeInfo.accountInfo.accountNostringYes收款方账号,根据付款方式不同填入相应账号
data.payeeInfo.accountInfo.accountTypestringNo收款账户类型,在不同国家-支付方式下规范不同
data.payeeInfo.accountInfo.checkDigitstringNo收款方账户验证数字
data.payeeInfo.bankInfoobjectNo收款方银行信息
data.payeeInfo.bankInfo.bankCodestringNo用于识别特定金融机构下的收款方银行代码,在不同国家下填写规范不同,参见【付款申请模板及填写规范】以及【支持银行范围列表
data.payeeInfo.bankInfo.bankNamestringNo收款方银行名称
data.payeeInfo.bankInfo.bankBranchstringNo收款人银行网点号/分行号
data.payeeInfo.bankInfo.bankCitystringNo收款方银行所在城市
data.payeeInfo.bankInfo.corAccountNostringNo收款方银行的代理账号(correspondent account)
data.payeeInfo.nameobjectNo收款方姓名,支持英文、空格、逗号、中划线、点,在不同国家-支付方式下填写规范不同
data.payeeInfo.name.firstNamestringNo收款方名
data.payeeInfo.name.middleNamestringNo收款方中间名,多段中间名时,使用空格进行分隔
data.payeeInfo.name.lastNamestringNo收款方姓
data.payeeInfo.name.fullNamestringNo收款方全名
data.payeeInfo.documentobjectNo收款方个人身份信息
data.payeeInfo.document.documentTypestringNo收款方个人身份证明类型,在不同国家下可选类型不同,参见《付款申请模板及填写规范
data.payeeInfo.document.documentIdstringNo收款方个人识别号码,在不同国家下可选类型不同,参见《付款申请模板及填写规范
data.payeeInfo.document.documentIssueDatestringNo收款方个人识别号码生效日期,在不同国家下可选类型不同,yyyy-MM-dd格式
data.payeeInfo.document.documentExpireDatestringNo收款方个人识别号码失效日期,在不同国家下可选类型不同,yyyy-MM-dd格式
data.payeeInfo.addressobjectNo收款方地址信息
data.payeeInfo.address.addressstringNo收款方地址
data.payeeInfo.address.citystringNo收款方城市
data.payeeInfo.address.statestringNo
data.payeeInfo.address.zipCodestringNo收款方邮编
data.payeeInfo.payeePhonestringNo收款方移动电话号码,在不同国家-支付方式下填写规范不同
data.payeeInfo.birthDatestringNo收款方出生日期,yyyy-MM-dd格式
data.payeeInfo.emailstringNo收款方邮箱
data.payeeInfo.payeeNationalitystringNo收款人国籍,ISO 3166-1 alpha-2标准,如CN,US
data.payeeInfo.payeeGenderstringNo收款人性别,枚举值F 或M(F=Female,M=Male)
data.payeeInfo.payeeBirthCountrystringNo收款人出生国家,ISO 3166-1 alpha-2标准,如CN,US
data.payerInfoobjectNo付款方信息
data.payerInfo.subMerchantNostringNo子商户号。子商户在系统中的唯一标识
data.payerInfo.businessLegalNamestringNo付款公司主体注册名
data.payerInfo.registrationCountrystringNo付款公司主体注册国家,2位大写国家编码
data.payerInfo.merchantCategoryCodestringNo付款公司行业分类,枚举值,DIGITAL_GOODS_MEDIA:数娱类产品-媒介;DIGITAL_GOODS_APPLICATION:数字产品-应用软件类;TRAVEL_AGENCIES_AND_TRAVEL_RELATED_SERVICES:旅行社;COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS:快递服务-空运、陆运及货物运输代理商;ADVERTISING_SERVICES:广告业务;TELECOMMUNICATION_SERVICE:电信服务;COMPUTER_NETWORKS_AND_INFORMATION_SERVICES:计算机网络/信息服务;MISCELLANEOUS_GENERAL_MERCHANDISE:电商-杂项百货。
data.payerInfo.payerIdstringNo付款公司所属机构/平台商户号
data.payerInfo.nameobjectNo付款方姓名,支持英文、空格、逗号、中划线、点,在不同国家-支付方式下填写规范不同
data.payerInfo.name.firstNamestringNo付款方名
data.payerInfo.name.middleNamestringNo付款方中间名,多段中间名时,使用空格进行分隔
data.payerInfo.name.lastNamestringNo付款方姓
data.payerInfo.name.fullNamestringNo付款方全名
data.riskParamsobjectNo风控业务数据
data.riskParams.registerNamestringNo注册账号持有人姓名
data.riskParams.registerNostringNo商户网站/app上用户的注册标识
data.riskParams.nickNamestringNo商户网站/app上用户的昵称
data.riskParams.thirdAccountNoTypestringNo第三方 帐户类型: 枚举值 Facebook, Google, AppleID,Others
data.riskParams.thirdAccountNostringNo第三方账号标识
data.riskParams.bindEmailstringNo账号绑定邮箱
data.riskParams.bindPhoneNostringNo账号绑定手机号
data.riskParams.accountLevelstringNo账号等级
data.riskParams.vipLevelstringNoVIP等级
data.riskParams.regTimestringNo账号注册时间,格式:yyyy-MM-dd HH:mm:ss
data.riskParams.lastLoginTimestringNo最后一次登录/活跃时间,格式:yyyy-MM-dd HH:mm:ss
data.riskParams.liveCountrystringNo现居住地址(国家维度),如CN
data.riskParams.taxIdstringNo用户税号
data.riskParams.cumPayoutAmountstringNo用户在商户侧,最近3个月累计出款成功金额(USD)
data.riskParams.cumPayoutTxnstringNo用户在商户侧,最近3个月累计出款成功笔数
data.riskParams.accountBalancestringNo用户在商户侧,用户账号当前余额 (金币/钻石)
data.riskParams.expressMerchantIDstringNo针对平台类商户下,在平台注册的卖家注册账号
data.expiryDaysstringNo取款码有效天数,当前仅在FawryCash中有效,支持传入1~15整数(1=24Hours),其他值或不传则默认为7
data.remarkstringNo出款附言或备注,允许英文,数字,中划线,空格,点;受渠道约束,该字段可能会进行特殊处理,如超长截断或填充默认值
data.referencestringNo透传数据,在付款异步回调通知中原样返回,该字段主要用于商户携带订单的自定义数据
data.notifyUrlstringNo商户接收付款结果的后台回调地址,以http/https开头
data.notifyEmailstringNo收款方通知邮箱,目前只有个别支付方式会发送取款码邮件,比如FAWRY
data.notifyPhonestringNo收款方通知电话
data.purposestringNo出款目的,枚举值,ISUBIL:向公用事业提供商付款(i.e.水电煤账单); EPTOUR:旅游业; EPTKAG:支付旅游门票或旅行社费用; ISPAYR:支付工资; ISPAYRA:支付代理工资; ISGDDS:货物买卖; ISSCVE:购买和销售服务; ISSUPP:供应商付款; ISLOGS:物流和运输服务付款; INCEN:激励/促销/用户获取活动; GAME:游戏设备、游戏币和其他游戏物品; SAMENM:企业同名账户转账; PAYCMSN:报销/福利发放/佣金发放; SAMENMC:法人/股东/董事个人账户; AGOPEXP:代运营费用结算; ADEXP:广告费用结算;RFND:退货;SMCNTST:子商户结算;LGTEP:供应商付款-物流费用结算;GOODPAY:供应商付款-货款结算;SINVEST:股票投资;FINVEST:基金投资;TAXPAY:纳税/支付税款;LOANPAY:支付贷款; OTHER:其他;

Responses

200

FieldTypeRequiredDescription
codestringYes返回码,APPLY_SUCCESS代表成功。只代表接口请求成功,不代表订单状态。
msgstringYes返回描述,’Success.’
dataobjectYes返回数据体
data.outTradeNostringYes商户订单号
data.tradeNostringYesPayerMax交易流水号
data.statusstringNo交易状态

此页面的内容有帮助吗?

感谢您帮助改进 PayerMax 产品文档!

Last updated:

Released under the MIT License.