支付订单/paymentOrder

post

https://api.futurepay-develop.com/payin/paymentOrder

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

支付请求

支付请求信息，包含用于处理支付请求的详细信息。

amount

object

required

支付金额。

paymentMethod

object

required

支付方式的详细信息。

reference

string

required

唯一标识支付的参考。此参考用于您与支付状态的所有通信中。我们建议每笔支付使用唯一值；但这不是必需的。如果需要为交易提供多个参考，请用连字符（"-"）分隔。最大长度：80 个字符。

returnUrl

string

required

在重定向情况下返回的 URL。格式取决于通道。对于 Web，请包含协议 http:// 或 https://。您还可以包含自己的附加查询参数，例如购物者 ID 或订单参考编号。示例：https://your-company.com/checkout?shopperOrder=12xy * 对于 iOS，请使用您的应用程序的自定义 URL。要了解更多关于设置自定义 URL 方案的信息，请参阅 Apple 开发者文档。示例：my-app:// * 对于 Android，请使用由应用程序中的活动处理的自定义 URL。您可以使用 intent filter 配置它。示例：my-app://your.package.name

merchantAccount

string

商户帐户标识符，用于处理交易。

accountInfo

object

账户信息。

additionalAmount

object

附加金额。

additionalData

object

此字段包含特定支付请求可能需要的附加数据。additionalData 对象由每个条目的键和值组成。

applicationInfo

object

应用信息。

authenticationData

object

身份验证数据。

billingAddress

object

账单地址。

browserInfo

object

浏览器信息。

captureDelayHours

int32

授权与计划自动扣款之间的延迟，以小时为单位指定。

channel

string

enum

支付交易发生的平台。此字段是可选的，用于过滤仅在特定平台上可用的支付方式。如果未设置此值，我们将尝试从 sdkVersion 或 token 中推断。可能的值：iOS、Android、Web

Allowed:

checkoutAttemptId

string

结账尝试 ID 对应于由客户端 SDK 生成的 ID，用于跟踪用户支付路径。

company

object

公司信息。

conversionId

string

转换 ID 对应于由客户端 SDK 生成的 ID，用于跟踪用户支付路径。

countryCode

string

购物者国家。格式：ISO 3166-1 alpha-2 示例：NL 或 DE

dateOfBirth

string

购物者的出生日期。格式 ISO-8601：YYYY-MM-DD

dccQuote

object

动态货币转换报价，包含外汇交易的详细信息。

deliverAt

date-time

购买商品的交货日期和时间。格式 ISO 8601：YYYY-MM-DDThh:mm:ss.sssTZD 示例：2017-07-17T13:42:40.428+01:00

deliveryAddress

object

送货地址信息，包含购买商品的送货地址详细信息。

deliveryDate

date-time

购买商品的交货日期和时间。格式 ISO 8601：YYYY-MM-DDThh:mm:ss.sssTZD 示例：2017-07-17T13:42:40.428+01:00

deviceFingerprint

string

包含购物者设备指纹的字符串。

enableOneClick

boolean

当设置为 true 且提供了 shopperReference 时，将询问购物者是否应存储支付详细信息以供将来的一键支付。

enablePayOut

boolean

当设置为 true 且提供了 shopperReference 时，支付详细信息将被标记以进行支出。

enableRecurring

boolean

当设置为 true 且提供了 shopperReference 时，支付详细信息将被标记以进行定期支付。

entityType

string

enum

处理支付的实体类型。

Allowed:

fraudOffset

int32

一个整数值，添加到正常的欺诈评分中。该值可以是正数或负数。

fundOrigin

object

资金来源，包含资金起源的详细信息。

fundRecipient

object

资金接收者，包含资金接收者的详细信息。

industryUsage

string

enum

金额更新的原因。可能的值：delayedCharge - 延迟收费。noShow - 未到。installment - 分期付款。

Allowed:

installments

object

分期付款信息，包含分期付款的详细信息。

lineItems

array of objects

购买商品的价格和产品信息，将包含在发送给购物者的发票上。此字段是 3x 4x Oney、Affirm、Afterpay、Clearpay、Klarna、Ratepay 和 Zip 所必需的。

lineItems

localizedShopperStatement

object

localizedShopperStatement 字段允许您使用本地字符集的动态值进行购物者声明。如果未提供、留空或跨境交易，将使用shopperStatement。当前支持日本使用日本卡的 Visa 和 Mastercard 支付的 ja-Kana 字符集。此字符集支持：基于 UTF-8 的片假名、大写字母、数字和特殊字符。半宽或全宽字符。

mandate

object

授权信息，包含定期付款的授权详细信息。

mcc

string

商户类别代码 (MCC) 是一个四位数的代码，与特定市场细分相关。此代码反映了商户进行的主要活动。

merchantId

string

商户ID。

merchantOrderReference

string

此参考允许将多个交易链接在一起以进行报告（即订单授权率）。每个计费周期的参考应唯一。首次授权尝试后，同一商户订单参考不得重复使用。如果使用，应为所有传入授权提供此字段。我们强烈建议您发送 merchantOrderReference 值，以便在授权重试时利用链接支付请求。此外，我们建议您在 PaymentRequest.additionalData 中提供 retry.orderAttemptNumber、retry.chainAttemptNumber 和 retry.skipRetry 值。

merchantRiskIndicator

object

商户风险指标，包含评估交易风险的详细信息。

metadata

object

元数据由每个条目的键和值组成。限制：每个请求最多 20 个键值对。超过时，会发生 "177" 错误："元数据大小超出限制"。每个键最多 20 个字符。每个值最多 80 个字符。

mpiData

object

MPI 数据，包含3D Secure 交易的详细信息。

order

object

加密订单数据，包含订单的加密详细信息。

orderReference

string

当您进行多次部分（礼品卡）支付时，这是首次支付的 pspReference。我们使用此来将多次支付链接在一起。作为链接多次支付的您自己的参考，请改用 merchantOrderReference。

origin

string

3D Secure 2 channel Web 集成所需。将此参数设置为加载 3D Secure 组件的页面的原始 URL。

paymentExchange

string

支付交换信息。

paymentExchangeMarkup

number

支付交换加价。

paymentExchangeRate

string

支付交换汇率。

platformChargebackLogic

object

平台拒付逻辑，包含处理拒付的详细信息。

processingAmount

string

处理金额。

processingCurrency

string

处理货币。

productId

string

产品ID。

recurringExpiry

string

不再执行授权的日期。仅适用于 3D Secure 2。

recurringFrequency

string

授权之间的最少天数。仅适用于 3D Secure 2。

recurringProcessingModel

string

enum

定义定期支付类型。创建用于存储支付详细信息的令牌或使用存储的支付详细信息时需要。允许的值：Subscription - 固定或可变金额的交易，遵循固定时间表。CardOnFile - 使用文件卡（CoF）交易，卡详细信息被存储以启用一键式或全渠道旅程，或简化结账过程。任何不遵循固定时间表的订阅也被视为文件卡交易。UnscheduledCardOnFile - 未安排的文件卡（UCoF）交易是指在非固定时间表上发生且/或金额可变的交易。例如，当持卡人的余额低于某一金额时，自动充值。

Allowed:

redirectFromIssuerMethod

string

指定从发行人重定向回来的重定向方法（GET 或 POST）。

redirectToIssuerMethod

string

指定重定向到发行人的重定向方法（GET 或 POST）。

riskData

object

风险数据，包含用于风险评估的信息。

sessionValidity

string

会话保持有效的日期和时间，格式为 ISO 8601。例如：2020-07-18T15:42:40.428+01:00

shopperEmail

string

购物者的电子邮件地址。我们建议您提供此数据，因为它用于速度欺诈检查。对于 3D Secure 2 交易，方案要求所有基于浏览器和移动实施的 shopperEmail。

shopperIP

string

购物者的 IP 地址。一般来说，我们建议您提供此数据，因为它用于多种风险检查（例如，支付尝试次数或基于位置的检查）。对于 3D Secure 2 交易，方案要求所有基于浏览器实施的 shopperIP。根据您的业务模型，这对于某些商户也是强制性的。

shopperInteraction

string

enum

指定购物者提供其卡详细信息的销售渠道，以及购物者是否是回头客。对于 Web 服务 API，默认假定电子商务购物者交互。此字段有以下可能值：Ecommerce - 持卡人在线存在的在线交易。为了更好的授权率，我们建议随请求一起发送卡安全码（CSC）。 ContAuth - 文件卡和/或订阅交易，持卡人已知（回头客）。如果购物者在线存在，您也可以提供 CSC 以提高授权（一次点击支付）。Moto - 购物者通过电子邮件或电话与商户联系的邮购和电话订单交易。 POS - 购物者在场使用安全支付终端进行支付的销售点交易。

Allowed:

shopperLocale

string

用于指定支付语言的语言代码和国家代码组合。

shopperName

string

shopperReference

string

定期付款所需。您唯一标识此购物者的参考，例如用户 ID 或帐户 ID。最小长度：3 个字符。您的参考不得包含个人身份信息（PII），例如姓名或电子邮件地址。

shopperStatement

string

购物者银行对账单上显示的文本。我们建议发送最多 22 个字符，否则银行可能会截断字符串。允许的字符：a-z, A-Z, 0-9, 空格和特殊字符 . , ' _ - ? + * /_.

socialSecurityNumber

string

购物者的社会安全号码。

splits

array of objects

使用平台时，指定如何拆分支付的对象数组。

splits

store

string

如果您有平台设置，则平台集成所需，用于处理支付的电子商务或销售点商店。

storePaymentMethod

boolean

当设置为 true 且提供了 shopperReference 时，支付详细信息将被存储。

telephoneNumber

string

购物者的电话号码。

threeDS2RequestData

object

3D Secure 2 请求数据，包含3D Secure 2身份验证所需的详细信息。

threeDSAuthenticationOnly

boolean

如果设置为 true，您将只执行3D Secure 2身份验证，而不是支付授权。

trustedShopper

boolean

如果支付应路由到受信任的 MID，请设置为 true。

Responses

201

已创建

401

未经授权

403

禁止

404

未找到

200成功