跳到主要内容

概述​

本文档详细描述了使用OPCCOUNT接口时所需的通用参数、业务参数的格式、规则和要求。请在发起请求前仔细阅读。

调用流程​

通用请求头（所有接口必传）​

这部分是所有接口都需要的公共参数，通常与身份认证、签名和账单基础信息相关。

参数名类型是否必填描述示例
Content-Typestring是数据类型application/json
Opccount-Nostring是OPCCOUNT号VA995149
Va-Codeint是商户唯一值，由oceanpayment提供9435762187450928365
Signstring是加密值ckQHqFTsawqHScEhxuovywiXTJMio9F0a62qdh/mIONvwWXzfdNFM4cl/2UN490VER64wmw18wOWsgHH/mKL7L+uu5jRQcLkYbwE5CfQEj6g2jHewa70b2zStZPes4DRrgRwLzK+vqwzdP0jifrRYbrB6qVjS8gD4RyGort/Ju1mfaVjJNgPlUWehDJPWPz5MAU/dRpB6ChX7IwjJm4cV/jUqZvOJMDqMov8H5kMyi7g0Jx7LVHIqx9O3Cjn+k+FASpJNNOnv7m5JjvdJkJYXgMC3pGK+uBc+hfHnc20piuz7KxDeQDtaAY9IXCWkPx8BcQaru1HMQgXmBicS85YkQ==
Timestampint是时间戳1694482115

加密​

  • 签名方式：使用sha256WithRSA，在线生成公私钥对 ，生成位数：2048位(bit)，请将生成的公钥提供给Oceanpayment技术支持，私钥保留作为加密传参。
  • 签名参数说明：除上传的附件以外，所有的body请求参数按字典排序+timestamp，timestamp与请求头时间戳一致。
$privateKey = "xxxx";//私钥
//字典排序
$sign_data={"billCurrency": ['USD'],"endDate": "2025-02-12 23:59:49","pageNum": 1,"pageSize": 1,"startDate": "2025-02-12 18:59:49","timestamp": "1694482115"};
$key = openssl_get_privatekey($privateKey);
openssl_sign($sign_data, $signature, $key, OPENSSL_ALGO_SHA256);
openssl_free_key($key);
$sign = base64_encode($signature);

账户资金​

资金明细查询​

参数名类型长度是否必填描述示例
pageNumint5否当前页码
  • 默认为1
pageSizeint5否每页容量
  • 默认为10
startDateint19否开始时间
  • 格式为yyyy-MM-dd HH:mm:ss，与结束时间之间间隔不能超过一年
endDateint19否结束时间
  • 格式为yyyy-MM-dd HH:mm:ss，与开始时间两者之间间隔不能超过一年
billCurrencyarray否币种集合
  • AUD
  • HKD
  • CHF
  • SGD
  • JPY
  • EUR
  • GBP
  • USD
  • CAD
  • NZD
  • ZAR
  • CNY

查询余额​

参数名类型描述示例
msgstring描述
codeint状态码
dataobject数据
currencystringOPCCOUNT币种
amountstringOPCCOUNT金额
withdrawalAmountstring可提现金额
congealAmountstring冻结金额

提现账户​

查询提现账户列表​

参数名类型描述示例
msgstring描述
codeint结果代码
dataobject数据
bankAccountstring收款方银行账号
withdrawalAccountKeystring提现账户ID
isRecordint是否已备案
  • 0： 未备案
  • 1： 已备案
  • 2： 无需备案
currencystring账户提现币种
bankNamestring银行名称
bankHolderstring银行开户名称
typeint银行账户类型
  • 1： 公司账户
  • 2： 个人账户
statusint状态
  • -1： 审核中
  • 0： 审核失败
  • 1： 正常

新增提现账户​

参数名类型长度是否必填描述示例
bankHolderstring200是收款方开户名
bankNamestring200是收款方开户银行
bankAccountstring200是银行账号
settlementNumberstring200是证件号
  • swiftCode的五六位等于NZ或者PE的时候必填
settlementTypestring278否证件类型
swiftCode的五六位等于NZ或者PE的时候必填
  • 1： 身份证
  • 2： 营业执照号（通用）
  • 8： 统一社会信用代码（三证合一企业）
  • 9： 组织结构代码（其他企业）
bankHolderPhonestring200否银行预留手机号
bankAddressstring200是银行地址
  • 当提现币种不等于CNY的时候必填
addressstring200否收款方地址
provincestring200是收款方汇入省
  • 当提现币种等于USD的时候必填
citystring200是收款方城市
  • 当提现币种等于USD的时候必填
zipcodestring200是邮编
  • 当提现币种等于USD的时候必填
currencystring3是提现币种
typeint1是银行账户类型
香港主体才有公司账户
  • 1： 公司账户
  • 2： 个人账户
swiftCodestring20是SWIFT CODE
  • 非CNY需要必填
bankProvincestring200否银行所在省
bankCitystring200否银行所在市
bankCodestring200否银行所在国家区域
  • ID等于152必填
branchCodestring200否BRANCH CODE
  • swiftCode查询匹配字段列表存在branchCode必填
ibanNumberstring278否IBAN Number
  • 提现币种等于EUR或GBP或TRY且国家区域是欧洲时必填
abaNumberstring278否ABA Number
  • 提现币种等于USD或CAD且国家区域是美国时必填
bsbNumberstring278否BSB Number
  • 提现币种等于AUD 且国家信息是澳洲时必填
sortCodestring6是Sort code
  • swiftCode查询匹配字段列表存在sortCode必填
clabestring18否Clabe
  • swiftCode查询匹配字段列表存在clabe必填
beneficiaryMsisdnstring6是收款人手机号（国际格式）
  • 当swiftCode的五六位等于JP的时候必填
fileListobject是文件列表

修改提现账户​

参数名类型长度是否必填描述示例
bankHolderstring200是收款方开户名
bankNamestring200是收款方开户银行
bankAccountstring200是银行账号
settlementNumberstring200是证件号
  • swiftCode的五六位等于NZ或者PE的时候必填
settlementTypestring278否证件类型
swiftCode的五六位等于NZ或者PE的时候必填
  • 1： 身份证
  • 2： 营业执照号（通用）
  • 8： 统一社会信用代码（三证合一企业）
  • 9： 组织结构代码（其他企业）
bankHolderPhonestring200否银行预留手机号
bankAddressstring200是银行地址
  • 当提现币种不等于CNY的时候必填
addressstring200否收款方地址
provincestring200是收款方汇入省
  • 当提现币种等于USD的时候必填
citystring200是收款方城市
  • 当提现币种等于USD的时候必填
zipcodestring200是邮编
  • 当提现币种等于USD的时候必填
currencystring3是提现币种
typeint1是银行账户类型
香港主体只有公司账户
  • 1： 公司账户
  • 2： 个人账户
swiftCodestring20是SWIFT CODE
  • 非CNY需要必填
bankProvincestring200否银行所在省
bankCitystring200否银行所在市
bankCodestring200否银行所在国家区域
  • ID等于152必填
branchCodestring200否BRANCH CODE
  • swiftCode查询匹配字段列表存在branchCode必填
ibanNumberstring278否IBAN Number
  • 提现币种等于EUR或GBP或TRY且国家区域是欧洲时必填
abaNumberstring278否ABA Number
  • 提现币种等于USD或CAD且国家区域是美国时必填
bsbNumberstring278否BSB Number
  • 提现币种等于AUD 且国家信息是澳洲时必填
sortCodestring6是sort code
  • swiftCode查询匹配字段列表存在sortCode必填
clabestring18否clabe
  • swiftCode查询匹配字段列表存在clabe必填
beneficiaryMsisdnstring6是收款人手机号（国际格式）
  • 当swiftCode的五六位等于JP的时候必填
fileListobject是文件列表
withdrawalAccountKeyobject50是账户唯一值

删除提现账户​

参数名类型长度是否必填描述示例
withdrawalAccountKeystring20是账户唯一值

代付账户​

查询代付账户列表​

参数名类型长度是否必填描述示例
keyWordsstring200否搜索关键词——币种
receiptOpccountNostring20否收款方OPCCOUNT号

新增代付账户​

参数名类型长度是否必填描述示例
receiptOpccountNostring20是收款方OPCCOUNT号
  • 当类型是OPCCOUNT账户的时候不能为空

删除代付账户​

参数名类型长度是否必填描述示例
fundPaymentAccountKeyint19是代付账户唯一值

提现​

提现记录查询​

参数名类型长度是否必填描述示例
startTimestring19Yes开始时间
  • 格式: yyyy-MM-dd HH:mm:ss
endTimestring19Yes结束时间
  • 格式: yyyy-MM-dd HH:mm:ss
pageSizeint5No每页容量
  • 默认为10
pageNumint5No页码
  • 默认为1
statusint1No提现状态
  • -1: 待处理
  • 0: 失败
  • 1: 成功
  • 2: Send back
  • 3: 取消
withdrawalCurrencyarray3No提现币种

询价​

参数名类型长度是否必填描述示例
withdrawalAccountKeystring20是提现账户唯一值
billCurrencystring3是账单币种
billAmountstring18是账单金额
  • 最多传12位整数和6位小数
transactionFeesBearingMethodsstring3是手续费承担方式
  • BEN
  • OUR
  • SHA

提现下单申请​

参数名类型长度是否必填描述示例
withdrawalAccountKeystring20是提现账户唯一值
billCurrencystring3是账单币种
billAmountstring18是账单金额——最多传12位整数和6位小数
transactionFeesBearingMethodsstring3是手续费承担方式 BEN/OUR/SHA

代付​

代付申请​

参数名类型长度是否必填描述示例
fundPaymentAccountKeystring20二选一代付账户唯一值
  • 代付账户列表查询中找到对应的代付账户唯一值
withholdingAccountKeystring20二选一代扣账户唯一值
只能填入一个，多笔代扣需要发送多笔请求
  • 当 withholdingAccountKey不为空：用OPCCOUNT号匹配代理商OPC号进行代扣
    • 付款方：withholdingAccountKey传OPCCOUNT号（代理商OPC号）；
    • 收款方：请求头中的OPCCOUNT号（主账号OPC号）
  • 当 withholdingAccountKey为空：代付申请逻辑。
    • 付款方：请求头中的OPCCOUNT号；
    • 收款方：用 fundPaymentAccountKey账户唯一值作为收款方
paymentAmountstring18是代付付款金额
  • 最多传12位整数和6位小数
paymentCurrencystring3是代付付款币种
  • 采用国际标准ISO 4217
accountTypeint18是账户类型
  • 1：OPCCOUNT账户
autoDebitint1是代付自动扣款
  • 1： 开启
  • 2： 关闭
transactionTypeint1是代付交易类型
  • 1： 广告商/Overseas Advertisers
  • 2： 物流服务商/Overseas Logistics
  • 3： 供应商/Overseas Supplier
  • 4： 业务/股权关联公司/Business/Equity Related Companies
  • 5： 集团间子公司/Inter Group Subsidiaries
orderNumberstring0-50否交易订单号
orderCurrencystring0-3否订单号的交易币种——传值会原样返回，无校验
orderAmountstring0-10否订单号的交易金额
orderNotesstring0-500否订单备注信息，返回时则原样返回
paymentDescstring278否代付付款说明
notesOnBankstring278否银行转账备注
confirmAgreementstring1是确认协议——默认传1
cooperationAgreementListfile否合作协议附件
  • 当applicationType = 1-首次申请 且 （transactionType = 4-业务/股权关联公司 或 5-集团间子公司）且 payerName = 0-oceanpayment 时，必传附件：代付公司注册证书+代付银行账户证明+代付个人地址证明+代付股权架构图+Invoice&合作协议附件id
  • 当applicationType = 1.首次申请 且 （transactionType = 1.广告商 或 2.物流服务商 或 3.供应商） 时，必传附件：合作协议+发票
  • 当applicationType = 1-首次申请 且 （transactionType = 4-业务/股权关联公司 或 5-集团间子公司）且 payerName = 1-商户主体 时，必传附件：代付公司注册证书+代付银行账户证明+代付个人地址证明+代付股权架构图+代付子公司附件
  • 当applicationType = 2-再次申请 且 （transactionType = 1.广告商 或 2.物流服务商 或 3.供应商） 时，必传附件：合作协议+发票
  • 当applicationType = 2-再次申请 且 （transactionType = 4-业务/股权关联公司 或 5-集团间子公司）且 payerName = 0-oceanpayment 时，必传附件：Invoice&合作协议附件id
  • 当applicationType = 2-再次申请 且 （transactionType = 4-业务/股权关联公司 或 5-集团间子公司）且 payerName = 1-商户主体 时，必传附件：代付子公司附件
invoiceListfile否invoce附件（发票）
companyRegCertificateListfile否代付公司注册证书附件
bankAccountProofListfile否代付银行账户附件
personalAddressProofListfile否代付个人地址证明附件
equityStructureChartListfile否代付股权架构图附件
subsidiaryListfile否代付子公司附件
invoiceAndCooperationAgreementListfile否Invoice&合作协议附件

代付确认扣款​

参数名类型长度是否必填描述示例
batchNoint10是代付批次号
  • 代付申请 成功后，会返回代付批次号
billCurrencystring3是确认代付币种
  • 默认传代付申请的币种 paymentCurrency，如果需要换汇，则传对应的币种

代付记录查询​

参数名类型长度是否必填描述示例
pageSizeint5否每页容量
  • 默认为10
timeTypeint1否时间类型
  • 1： 申请时间
  • 2： 付款时间
currencyListarray5否付款币种集合
  • AUD
  • HKD
  • CHF
  • SGD
  • JPY
  • EUR
  • GBP
  • USD
  • CAD
  • NZD
  • ZAR
  • CNY
batchNostring10否付款批次号
  • 代付申请 成功后，会返回代付批次号
startTimestring19否开始时间
  • 格式：yyyy-MM-dd HH:mm:ss
endTimestring19否结束时间
  • 格式：yyyy-MM-dd HH:mm:ss
pageNumint5否当前页码
  • 默认为1
statusint2否代付状态
  • 1： 审核中
  • 2： 审核未通过
  • 3： 审核通过
  • 4： 处理中
  • 6： 代付成功
  • 7： 已退回
  • 9： 已退款
  • 10： 代付扣款失败
  • 12： 已取消

下载水单​

参数名类型长度是否必填描述示例
batchNoint10是代付批次号
  • 代付申请 成功后，会返回代付批次号

取消代付申请​

参数名类型长度是否必填描述示例
batchNoint10是代付批次号
  • 代付申请 成功后，会返回代付批次号