Warning

Before reading this API document, please make sure to check API Description Guide

Brief Description:

• Get merchant payment configuration information, including payment methods, fee rates, settlement periods, limits, etc.

URL：/common/payment/config

Parameters:

Parameter	Required	Type	Description
appId	Yes	Long	Business ID (retrieved from the backend, must match the currency in the URL)
tranType	No	String	Transaction type (e.g., BANK_ACCOUNT, BANK_CARD, EWALLET), if provided, only returns configurations for this transaction type
tranCode	No	Integer	Transaction code, 15=Payout, 20=Collection, if provided, only returns configurations for this transaction type
sign	Yes	String	Request signature, using merchant key for RSA signature

Return Data Parameters Description

Parameter	Type	Description
userId	Long	User ID
configs	Array	Configuration list
sign	String	Response signature

configs[] Configuration Item Description

Parameter	Type	Description
appId	Long	Application ID
appName	String	Application name
tranCode	Integer	Transaction type: 15=Payout, 20=Collection
tranType	String	Payment type (transaction method), e.g., BANK_ACCOUNT, BANK_CARD, EWALLET
currNo	String	Currency code (e.g., USD, CNY, MXN)
payMethods	Array	Payment method list
feeRate	Object	Fee rate information
settlement	Object	Settlement period information
limit	Object	Limit information
supportRefund	Boolean	Whether refund is supported (only USD + Collection + CREDIT_CARD supports refund)

payMethods[] Payment Method Description

Parameter	Type	Description
code	String	Payment method code
name	String	Payment method name

feeRate Fee Rate Information Description

Parameter	Type	Description
feeType	Integer	Fee collection method: 0=External deduction, 1=Internal deduction
feeMode	Integer	Fee collection type: 0=Rate, 1=Per transaction, 2=Tiered, 3=Base price
feeRate	String	Fee rate (when feeMode=0)
feeFixedValue	String	Fixed fee (when feeMode=1)
feeMinValue	String	Minimum fee
feeMaxValue	String	Maximum fee
degrees	Array	Tiered fee rate list (when feeMode=2)

feeRate.degrees[] Tiered Fee Rate Description

Parameter	Type	Description
start	Long	Interval start amount
end	Long	Interval end amount
value	String	Interval fee rate
name	String	Interval name

settlement Settlement Period Information Description

Parameter	Type	Description
stlMode	Integer	Settlement method: 0=D0 (Natural Day), 1=TN (Working Day), 2=WN (Weekly Settlement), 3=MN (Monthly Settlement)
stlCycle	Integer	Settlement cycle value

limit Limit Information Description

Parameter	Type	Description
singleMinAmount	String	Single transaction minimum amount
singleMaxAmount	String	Single transaction maximum amount

request

{
  "appId": 2054,
  "sign": "your_signature_here"
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "userId": 672,
    "configs": [
      {
        "appId": 2054,
        "appName": "jiwushanghu_USDT1",
        "tranCode": 15,
        "tranType": "EWALLET",
        "currNo": "USDT",
        "payMethods": [
          {
            "code": "TRX",
            "name": "TRX"
          },
          {
            "code": "BSC",
            "name": "USDT（BEP20）"
          }
        ],
        "feeRate": {
          "feeType": 0,
          "feeMode": 0,
          "feeRate": "0.4",
          "feeFixedValue": "4",
          "feeMinValue": "0",
          "feeMaxValue": "100000000000"
        },
        "settlement": {
          "stlMode": 0,
          "stlCycle": 0
        },
        "limit": {
          "singleMinAmount": "0",
          "singleMaxAmount": "999999999"
        },
        "supportRefund": false
      }
    ],
    "sign": "response_signature_here"
  }
}

Request Example with Filter Conditions

request

{
  "appId": 2054,
  "tranType": "BANK_CARD",
  "tranCode": 20,
  "sign": "your_signature_here"
}

response

{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "userId": 672,
    "configs": [
      {
        "appId": 2065,
        "appName": "jiwushanghu_MXN1",
        "tranCode": 20,
        "tranType": "BANK_CARD",
        "currNo": "MXN",
        "payMethods": [
          {
            "code": "OXXO",
            "name": "OXXO"
          }
        ],
        "feeRate": {
          "feeType": 1,
          "feeMode": 0,
          "feeRate": "0.2",
          "feeFixedValue": "0",
          "feeMinValue": "0",
          "feeMaxValue": "100000000000"
        },
        "settlement": {
          "stlMode": 0,
          "stlCycle": 0
        },
        "limit": {
          "singleMinAmount": "0.1",
          "singleMaxAmount": "999999999"
        },
        "supportRefund": false
      }
    ],
    "sign": "response_signature_here"
  }
}