字段

说明

customerId

必选 String (64)

收单机构为商家分配的唯一身份标识号。

PSP

必选 String (64)

支付服务供应商（PSP），负责交易处理的收单机构的名字。

该收单机构主要是指为您提供收单和资金结算服务的机构。

ARN

可选 String (256)

收单机构参考号（ARN），卡收单机构对每笔卡交易生成的唯一标识。

当支付方式为卡支付时，该字段可能有值。

referenceMerchantId

可选 String (64)

该字段的值与原支付或预授权请求中的 referenceMerchantId 字段的值相同。该字段指的是在 pay（单笔支付）接口中指定的 referenceMerchantId。

referenceStoreId

可选 String (64)

该字段的值与原支付或预授权请求中的 referenceStoreId 字段的值相同。

transactionId

必选 String (64)

Antom 分配的交易唯一标识。该字段的值遵循以下规则：

• 当 transactionType 为 PAYMENT、 AUTHORIZATION、 CANCEL、 CAPTURE、 REFUND、 DISPUTE、 DISPUTE_REVERSAL、 REFUND_REVERSAL、 PAYMENT_REVERSAL、 RAPID_DISPUTE_RESOLUTION 或者是 CDRN 时，该字段的值与 paymentId 的值相同。该字段指的是在 pay（单笔支付）接口中指定的 paymentId。

transactionRequestId

可选 String (64)

商家分配的交易请求唯一标识。该字段的值与付款的 paymentRequestId 的值相同，或与退款的 refundRequestId 的值相同。该字段指的是在 pay（单笔支付）接口、capture（单笔支付） 和 refund 接口中指定的请求 ID。

• 当 transactionType 为 PAYMENT、 AUTHORIZATION 、CAPTURE 、 REFUND 、CANCEL、REFUND_REVERSAL或者是 PAYMENT_REVERSAL 时，该字段的值不为空。
• 当 transactionType 为 DISPUTE、DISPUTE_REVERSAL 、 RAPID_DISPUTE_RESOLUTION 或者是 CDRN 时，该字段为空。

referenceTransactionId

必选 String (64)

直接向买家提供服务或商品的商家分配的用于识别交易的唯一标识。对于以下交易类型，该字段的值与原支付或预授权的 referenceOrderId 的值相同： PAYMENT、 AUTHORIZATION、 CAPTURE、CANCEL、 REFUND、DISPUTE、 DISPUTE_REVERSAL、 REFUND_REVERSAL、 PAYMENT_REVERSAL 、 RAPID_DISPUTE_RESOLUTION 或者 CDRN。该字段指的是在 pay（单笔支付）接口中指定的 referenceOrderId。

orderDescription

必选 String (256)

订单的说明。

该字段的值与原支付或预授权请求中的 orderDescription 字段的值相同。

paymentMethodType

必选 String (64)

支付方式。可用枚举值请查看支付方式文档。

该字段的值与原先支付或预授权请求中的 paymentMethodType 字段的值相同。

wallet

可选 String (64)

电子钱包名称，例如 Gcash。

transactionType

必选 String

交易类型，包含的值如下：

• PAYMENT：表示交易类型为支付。
• REFUND：表示交易类型为退款。
• CANCEL：表示交易类型为取消。
• AUTHORIZATION：表示交易类型为预授权。
• CAPTURE：表示交易类型为预授权后请款。
• REFUND_REVERSAL: 表示退款逆转，通常发生在不支持原路退款的支付方式中。资金则会返回到您的账户。
• PAYMENT_REVERSAL: 表示支付逆转，通常发生在不支持原路退款的支付方式中。资金则会返回到您的账户。
• RAPID_DISPUTE_RESOLUTION：表示交易类型为快速争议解决（RDR）。
• DISPUTE：表示交易类型为争议。
• DISPUTE_REVERSAL: 表示在争议中成功抗辩并胜诉。
• CDRN: 表示持卡人争议解决网络流程（CARDHOLDER_DISPUTE_RESOLUTION_NETWORK）。

status

必选 String (64)

交易状态。有效值为：

• PROCESSING：表示交易正在处理中。
• SUCCESS：表示交易成功。
• CLOSE：表示交易关闭。
• EXPIRED：表示交易超期。
• REFUSED：表示交易被拒绝。
• FAILED：表示交易失败。
• TO_BE_SETTLED：表示交易待结算。
• SETTLED：表示交易已结算。

transactionCreationTime

必选 String (64) 

当前数据的创建时间，格式为 YYYY-MM-DDTHH:MM:SS+hh:mm，遵循 ISO 8601 标准，如 PAYMENT 支付的创建时间或者 REFUND 退款的创建时间。

transactionUpdateTime

必选 String (64) 

交易状态变更时间，格式为 YYYY-MM-DDTHH:MM:SS+hh:mm，遵循 ISO 8601 标准。（例如，当 transactionType 为 PAYMENT 且状态从 TO_BE_SETTLED 更新为 SETTLED 时的时间。）

transactionCompletionTime

可选 String (64)

交易达到成功或失败终态的时间，格式为 YYYY-MM-DDTHH:MM:SS+hh:mm，遵循 ISO 8601 标准。

productCode

必选 String

Antom 和商家合同中约定的支付产品类型。值包含如下：

• AGREEMENT_PAYMENT：表示令牌支付。
• CASHIER_PAYMENT：表示单笔支付 。

该字段的值与原支付或预授权请求中的 productCode 字段的值相同。

transactionAmountValue

必选 String (16)

交易金额，以  transactionCurrency  币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

transactionCurrency

必选 String (3)

transactionAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码 。

installmentsNum

可选 String (8)

表示分期付款的期数。

issuingCountry

可选 String (2)

发卡国家或地区。该字段值是遵循 ISO 3166 标准的二位国家代码。

当 paymentMethodType 为 CARD 时该字段有值。

cardBrand

可选 String (256)

卡品牌。

当 paymentMethodType 为 CARD 时该字段有值。

fundingSource

可选 String (20)

支付方式的资金类型。当 paymentMethodType 为 CARD，GRABPAY_MY，或 GRABPAY_SG 时该字段有值。

• 当 paymentMethodType 为 CARD 时，包含值如下：

• CREDIT: 表示为信用卡。
• DEBIT: 表示为借记卡。
• PREPAID: 表示为预付费卡。
• CHARGE: 表示为充值卡。
• DEFERRED_DEBIT: 表示为延期借记卡。

• 当 paymentMethodType 为 GRABPAY_MY，或 GRABPAY_SG 时，包含值如下：

• WALLETS: 表示为钱包余额支付。
• BNPL: 表示先买后付。

settlementBatchId

可选 String (64)

收单机构分配的用于识别结算批次的唯一标识，与结算汇总文件中的结算批号相同。

convertedTransactionAmountValue

可选 String (16)

交易金额转换为结算币种后的金额，未扣费。以 convertedCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

convertedCurrency

可选 String (3)

convertedTransactionAmountValue 对应的币种， 为 ISO 4217 中定义的三位字母币种代码 。

settlementAmountValue

可选 String (16)

订单金额转换为结算币种后，扣除费用后的净结算金额。以 settlementCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

settlementCurrency

可选 String (3)

settlementAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码 。

quoteCurrencyPair

可选 String (16)

报价币种对，目前 Antom 使用外汇合作机构提供的标准币种对顺序进行报价。两种币种用斜线分隔，均为 ISO 4217 中定义的三位字母币种代码，如 EUR/USD。

若交易币种与结算币种相同，该字段为空。

quotePrice

可选 Decimal (20)

报价币种对时价，如 quoteCurrencyPair 为 EUR/USD 时，代表 EUR 换 USD 的汇率报价。

若交易币种与结算币种相同，该字段为空。

paymentMethodFeeAmountValue

可选 String (16)

由 Antom 收取的支付方式手续费金额。以 paymentMethodFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

paymentMethodFeeCurrency

可选 String (3)

paymentMethodFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码 。

taxFeeAmountValue

可选 String (16)

税费。以 taxFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

taxFeeCurrency

可选 String (3)

taxFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

processingFeeAmountValue

可选 String (16)

Antom 为每笔交易提供的支付处理服务费用金额。以 processingFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

processingFeeCurrency

可选 String (3)

processingFeeAmountValue 对应的币种。值为 ISO 4217 中定义的三位字母币种代码。

disputeHandlingFee

可选 String (16)

Antom 向商家收取的拒付处理的费用金额。以 disputeHandlingFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 transactionType 为 DISPUTE，status 为 TO_BE_SETTLED 或 SETTLED，且 Antom 向商户收取、退还该费用时该字段有值。

disputeHandlingFeeCurrency

可选 String (3)

disputeHandingFee 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

interchangeFeeAmountValue

可选 String (16)

发卡行收取的费用。以 interchangeFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 paymentMethodType 为 CARD，status 为 TO_BE_SETTLED 或 SETTLED，报价模式为 Interchange++ ，且发卡行向商户收取、退还该费用时该字段有值。

interchangeFeeCurrency

可选 String (3)

interchangeFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

schemeFeeAmountValue

可选 String (16)

卡组收取的费用，以 schemeFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 paymentMethodType 为 CARD，status 为 TO_BE_SETTLED 或 SETTLED，报价模式为 Interchange++ ，且卡组向商户收取、退还该费用时该字段有值。

schemeFeeCurrency

可选 String (3)

schemeFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

acquirerMarkupAmountValue

可选 String (16)

Antom 收取的费用。以 acquirerMarkupCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 paymentMethodType 为 CARD，status 为 TO_BE_SETTLED 或 SETTLED，报价模式为 Interchange++ ，且 Antom 向商户收取、退还该费用时该字段有值。

acquirerMarkupCurrency

可选 String (3)

acquirerMarkupAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

refundFeeAmountValue

可选 String (16)

针对退款交易，Antom  收取的费用。以 refundFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 transactionType 为 REFUND，status 为 TO_BE_SETTLED 或 SETTLED，且 Antom 向商户收取该费用时该字段有值。

refundFeeCurrency

可选 String (3)

refundFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

financingFeeAmountValue

可选 String (16)

分期支付场景中，Antom 向商家收取的服务费。以 financingFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 paymentMethodType 的值为 CARD，status 为 TO_BE_SETTLED 或 SETTLED，installmentsNum 有值，且 Antom 向商户收取、退还该费用时该字段有值。

financingFeeCurrency

可选 String (3)

financingFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

rdrFeeAmountValue

可选 String (16)

Antom 向商家收取的快速争议解决（RDR）类型交易的费用。以 rdrFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当商户通过 Antom 开通 RDR 服务且 transactionType 为 RAPID_DISPUTE_RESOLUTION 时，且 Antom 向商户收取、退还该费用时该字段有值。

rdrFeeCurrency

可选 String (3)

rdrFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母币种代码。

anticipationFeeAmountValue

可选 String (16)

Antom 向商家收取的结算周期加速服务费。以 anticipationFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当买家使用巴西本地卡的卡分期支付场景，或对客资金结算延迟天数小于 T+26 时，且 Antom 向商户收取、退还该费用时该字段有值。

anticipationFeeCurrency

riskDecisionServiceFeeAmountValue

可选 String (16)

风控决策处理费。以 riskDecisionServiceFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当商户未签约风控包赔能力时向商户收取；如商户签约风控包赔能力，则不收取。 此费项仅在 transactionType 为 AUTHORIZATION 时收取，不做退费。

riskDecisionServiceFeeCurrency

可选 String (3)

riskDecisionServiceFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

riskManagementFeeAmountValue

可选 String (16)

风控管理费。以 riskManagementFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当商户签约风控包赔能力时向商户收取；如商户未签约风控包赔能力，则不收取。 此费项仅在 transactionType 为 CAPTURE 时收取，不做退费。

riskManagementFeeCurrency

可选 String (3)

riskManagementFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

region

可选 String (16)

交易发生地区。有效值为：

• DOMESTIC：国内交易。发卡国、收单国、商户注册地为同一国家/地区。
• INTRAREGIONAL：区域内交易。发卡国、收单国、商户注册地不完全相同，但是所属区域相同。
• INTERREGIONAL：跨区域交易。发卡国、收单国、商户注册地不完全相同，所属区域也不完全相同。

3DAuthentication

可选 String (1)

用于银行卡交易的额外身份验证。此字段将返回验证结果：

• Y：当 3D 验证通过时，此字段的值为 Y。
• N：当 3D 验证不通过时，此字段的值为 N。

3DOffered

可选 String (1)

用于表示银行卡交易是否提供 3D 身份验证。此参数将返回以下结果：

• Y：当提供3D 验证时，此参数的取值为 Y。
• N：当未提供 3D 验证时，此参数的取值为 N。

accountHolderName

可选 String (256)

持卡人姓名。

originalCardSummary

可选 String (64)

银行卡号的前六位和后四位数字。例如：123456************1234

cardNumber (Last 4 digits)

可选 String (4)

银行卡后四位数字。

issuer

可选 String (32)

发卡行。

liabilityShift

可选 String (64)

有效值为：

• Yes：表示发卡机构将承担欺诈的财务风险。
• No：表示发卡机构不承担欺诈的财务风险

reason

可选 String (512)

此字段用于指示交易异常的原因，当交易失败时可能有值。

cardCategory

可选 String (256)

银行卡类别。有效值为：

• CONSUMER：个人卡。
• COMMERCIAL：商业卡。

metadata

可选 String (2048)

此字段指的是在 pay（单笔支付） 接口和 refund 接口中指定的 metadata。

cdrnFeeAmountValue

可选 String (16)

由 Antom 向商户收取的信用卡争议解决网络 (CDRN) 类型交易的费用金额。以 cdrnFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 transactionType 为 CDRN，且商户通过 Antom 开通 CDRN 服务时，且 Antom 向商户收取、退还该费用时该字段有值。

cdrnFeeCurrency

可选 String (3)

cdrnFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

originalTransactionRequestId

可选 String (64)

原始交易的标识。

• 当 transactionType 为 PAYMENT 或者 AUTHORIZATION 时，该字段的值为空。
• 当 transactionType 为 CANCEL、REFUND、CAPTURE、 DISPUTE、 DISPUTE_REVERSAL、 RAPID_DISPUTE_RESOLUTION、 PAYMENT_REVERSAL 或者 REFUND_REVERSAL 时，该字段的值与原支付或授权请求的 paymentRequestId 相同。

iofFeeAmountValue

可选 String (16)

IOF（Imposto sobre Operações Financeiras）费用是巴西联邦政府规定的一项税收，适用于特定金融业务，包括外汇交易、信用卡国际结算以及跨境投资等。以 iofFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当巴西联邦政府收取该税时该字段有值。

iofFeeCurrency

可选 String (3)

iofFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

withholdingTaxAmountValue

可选 String (16)

此字段表示根据相关当地税务法规在源头预扣的税额。它代表由付款方代扣并上缴至相应税务机关的交易金额部分。该数值通常根据适用的税率计算，可能因交易性质及相关方的分类不同而有所变化。以 withholdingTaxFeeCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当菲律宾政府收取该税时该字段有值。

withholdingTaxFeeCurrency

可选 String (3)

withholdingTaxAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

fxFeeAmountValue

可选 String (16)

Antom 为每笔交易提供外汇兑换（FX，即 Foreign exchange）服务所收取的处理费用金额。以 fxFeeAmountCurrency 币种单位展示。（例如，如果币种是 USD 金额是 $1.00，则将此参数的值设置为 1.00。或者如果币种是 JPY，金额是 ¥1，则将此参数的值设置为 1。）

当 Antom 向商户收取、退还该费用时该字段有值。

fxFeeAmountCurrency

可选 String (3)

fxFeeAmountValue 对应的币种，为 ISO 4217 中定义的三位字母的币种代码。

isCardOnFile

可选 String (1)

此参数用来指定此交易是否为卡信息存档（COF）交易。有效值为：

• Y：表示此交易是卡信息存档（COF）交易。
• N：表示此交易不是卡信息存档（COF）交易。

isNetworkToken

可选 String (1)

此参数用来指定此交易是否为卡组加密（NT）交易。有效值为：

• T：表示此交易是卡组加密（NT）交易。
• F：表示此交易不是卡组加密（NT）交易。