Apply Drop-in Session

• Endpoint: POST /aggregate-pay/api/gateway/applyDropinSession
• Tags: 收单/前置组件Drop-In

Description

在商户服务端调用该接口，获取用于初始化前置组件的主要参数。

注：商户如果有换汇或营销的诉求，可联系PayerMax技术支持。

Parameters

Field	In	Type	Required	Constraints	Description
Content-Type	header	string	Yes
sign	header	string	Yes		签名信息请参考技术文档

Parameter Examples

• Content-Type: "application/json"
• sign: "FPFVT3o227JrFRbqu19boZCpVVTF9KznxyRawUmxpfXilHV/0yK46haPhAjNu1hPUMy7Vw/ILXhfzffNm4Fj0apWknlTY9OJxnSoQxS9BTFtc61tn5yV1q69x/kkBl82/qwg+XTJ4fOzy7Mar3VaC1E2PlDA6RkkKBUyNE6RYgsdB+Su7an4+4HVTNAnoe74WyvBgxTLMNg28igBTdqxaO3w/UBY6ObVp7vkqkQGdL1Y+HgmMYaAVwrM3+ALWGId0sJ+YqTY4WJ+0xCRGhaSnybiIjZsQEYyID68WNUfuavDLDsEhaMm/HfQvf5p0R1Ltovp3wwJnEbQcjY458iX5A=="

Request Body

Content-Type: application/json

Field	Type	Required	Constraints	Description	Enum
version	string	Yes	maxLength: 8	接口版本 当前值为：1.4
keyVersion	string	Yes	maxLength: 8	密钥版本 当前值为：1
requestTime	string	Yes	maxLength: 32	请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内
appId	string	Yes	maxLength: 64	商户应用Id，PayerMax分配给商户应用的唯一标识
merchantNo	string	No	maxLength: 32	商户号，商户与PayerMax业务签约时生成的唯一标识
data	object	Yes
data.totalAmount	string	No		只有传了mitType时，totalAmount才支持传0；其他情况需要大于0
data.mitType	string	No		签约代扣产品后，可传mitType	SCHEDULED, UNSCHDULED
data.currency	string	Yes	maxLength: 3	标价币种，大写字母，参见【交易支持国家/地区与币种】
data.country	string	Yes	maxLength: 2	国家代码，大写字母，参见【交易支持国家/地区与币种】。 如指定了paymentMethodType，则国家代码必须上送且和支付方式对应国家匹配。 收银台可用国家地区选择策略为：上送国家代码地区>用户历史使用国家代码地区>用户IP所在国家代码地区。（可用国家地区：交易币种对应的国家与签约国家取交集）
data.userId	string	Yes	maxLength: 64	商户内部的用户Id，需要保证每个ID唯一性。支付方式绑定后会根据userId进行支付方式推荐
data.referralCode	string	No	maxLength: 32	用于更精准的支付方式推荐，如设备ID、设备指纹等。
data.tokenForFutureUse	boolean	No	default: false	token支付标识，true标识支持token支付，false表示不支持token支付，默认false
data.componentList	array[string]	No		如：CARD，APPLEPAY，GOOGLEPAY

Example

{
  "version": "1.1",
  "keyVersion": "1",
  "requestTime": "2022-01-17T09:05:52.194+00:00",
  "appId": "3b242b56a8b64274bcc37dac281120e3",
  "merchantNo": "020213827212251",
  "data": {
    "currency": "IDR",
    "country": "ID",
    "userId": "U10001",
    "tokenForFutureUse": false,
    "componentList": [
      "CARD",
      "APPLEPAY"
    ]
  }
}

Responses

200

Field	Type	Required	Constraints	Description	Enum
code	string	Yes
msg	string	Yes
data	object	Yes
data.sessionKey	string	Yes		Drop-in
data.clientKey	string	Yes		前端SDK初始化参数
data.notSupportedComponent	array[string]	Yes

Response Example

{
  "code": "APPLY_SUCCESS",
  "msg": "Success.",
  "data": {
    "clientKey": "37114858239eur2384237r810482390",
    "sessionKey": "bdsf8982348974hhf82934bf8239424",
    "notSupportedComponent": []
  }
}

Enum Reference

data.mitType

• SCHEDULED
• UNSCHDULED