Skip to main content

​
1. Brief Description:

  • Query merchant available payment configuration information based on application ID, including payment methods, fee rates, settlement periods, and other configurations
URL： /common/payment/config HTTP Method： POST Content-Type： application/json
  1. The request requires signature verification and the signature algorithm should be consistent with other interfaces.
  2. tranType and tranCode are optional parameters used to filter specific types of payment configurations.
  3. If the application has not configured the payment product, the returned configs list will be empty.
  4. The response data will also be signed. The signature is the same as other methods, but note that the returned data of this interface has multiple levels of nesting.
  5. If the input currency is “Cashier”, it will return all the available app payment configuration information for this user.

​
2. Request Parameters:

ParameterRequiredTypeDescription
appIdYesLongBusiness ID (obtained from the backend)
tranTypeNoStringPayment type (optional). If provided, filter by payment type. See tranType
tranCodeNoStringtranCode type (optional). If provided, filter by tranCode type. See tranCode
signYesStringSignature

​
3. Response Data:

ParameterTypeDescription
userIdLongUser ID
configsList<PaymentConfig>Configuration list
signStringSignature
PaymentConfig Object:
ParameterTypeDescription
appIdLongApplication ID
appNameStringApplication name
tranCodeStringtranCode type: pay=payout, collect=collection
tranTypeStringPayment type (transaction method). See tranType
currNoStringCurrency code (e.g., USD, CNY)
payMethodsList<PayMethod>Payment method information list
feeRateFeeRateFee rate information
settlementSettlementSettlement period information
supportRefundBooleanWhether refund is supported, see refund support section
PayMethod Object:
ParameterTypeDescription
inBankCodeStringPayment method code (inBankCode)
nameStringPayment method name
limitLimitPayment method limit information (intersection of t_pay_code and t_mer_app)
Limit Object:
ParameterTypeDescription
singleMinAmountStringMinimum single transaction amount
singleMaxAmountStringMaximum single transaction amount
FeeRate Object:
ParameterTypeDescription
feeTypeIntegerFee collection method. See feeType
feeModeIntegerFee collection type. See feeMode
feeRateStringFee rate
feeFixedValueStringFixed fee
degreesList<FeeDegree>Tiered fee rate list (if fee_mode=2)
FeeDegree Object:
ParameterTypeDescription
startLongRange start
endLongRange end
valueStringRange value (tiered fee rate)
nameStringRange name
Settlement Object:
ParameterTypeDescription
stlModeStringSettlement method. See stlMode
stlCycleIntegerSettlement cycle value

​
4. Request and Response Examples

{
  "appId": 2065,
  "sign": "PjQFVs4HxYM+skZ+9+O6LzrmgAeDRn6YgaM9ka+kynv8WH36HU6soMGWSV0GiO5ApPMdnpWbRdGt2jkcTFQ4+ZZ/2JxJsV0MGbwH5EGCxXb5vJar2v3l43WwpI9DDwpSjpYqrCA+XlXMA2oD3ZuOsqTKa49E2EgEhWa9mvS/5id+R6V03Zf1wy/sEsFya2zLVF2jK9zRVpQ+pOgAlT++EUPHzMtnAkfj2/CcSFE8Pl0v//HCcw/5dzLFIgpoUH/h6xSgzinndCQVA6Yy4JX9av/K554GpHHE1jw+PqZSW5JbYss/XpT2ltb3ieUdhiqvEHM9NGncBlWptk1KmDywKg\u003d\u003d"
}
Response Example: 
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "userId": 672,
    "configs": [{
      "appId": 2065,
      "appName": "jiwushanghu_MXN1",
      "tranCode": "pay",
      "tranType": "BANK_ACCOUNT",
      "currNo": "MXN",
      "payMethods": [{
        "inBankCode": "ACCENDO_BANCO",
        "name": "ACCENDO_BANCO",
        "limit": {
          "singleMinAmount": "3",
          "singleMaxAmount": "2000"
        }
      }, {
        "inBankCode": "ABC_CAPITAL",
        "name": "ABC_CAPITAL",
        "limit": {
          "singleMinAmount": "3",
          "singleMaxAmount": "2000"
        }
      }],
      "feeRate": {
        "feeType": 1,
        "feeMode": 1,
        "feeRate": "0",
        "feeFixedValue": "8.8"
      },
      "settlement": {
        "stlMode": "WN",
        "stlCycle": 4
      },
      "supportRefund": false
    }, {
      "appId": 2065,
      "appName": "jiwushanghu_MXN1",
      "tranCode": "collect",
      "tranType": "QR",
      "currNo": "MXN",
      "payMethods": [{
        "inBankCode": "CASH",
        "name": "Pay Cash",
        "limit": {
          "singleMinAmount": "5.1",
          "singleMaxAmount": "2000"
        }
      }],
      "feeRate": {
        "feeType": 1,
        "feeMode": 0,
        "feeRate": "0.035",
        "feeFixedValue": "0.2"
      },
      "settlement": {
        "stlMode": "TN",
        "stlCycle": 2
      },
      "supportRefund": false
    }, {
      "appId": 2065,
      "appName": "jiwushanghu_MXN1",
      "tranCode": "collect",
      "tranType": "VA",
      "currNo": "MXN",
      "payMethods": [{
        "inBankCode": "CLABE",
        "name": "CLABE",
        "limit": {
          "singleMinAmount": "5.1",
          "singleMaxAmount": "2000"
        }
      }],
      "feeRate": {
        "feeType": 1,
        "feeMode": 0,
        "feeRate": "0.035",
        "feeFixedValue": "0.2"
      },
      "settlement": {
        "stlMode": "TN",
        "stlCycle": 2
      },
      "supportRefund": false
    }, {
      "appId": 2065,
      "appName": "jiwushanghu_MXN1",
      "tranCode": "collect",
      "tranType": "VA",
      "currNo": "MXN",
      "payMethods": [{
        "inBankCode": "CLABE",
        "name": "CLABE",
        "limit": {
          "singleMinAmount": "5.1",
          "singleMaxAmount": "2000"
        }
      }],
      "feeRate": {
        "feeType": 1,
        "feeMode": 0,
        "feeRate": "0.035",
        "feeFixedValue": "0.2"
      },
      "settlement": {
        "stlMode": "TN",
        "stlCycle": 2
      },
      "supportRefund": false
    }],
    "sign": "Uw3xtKg3c772USUDvd5SDv9HjRU/WUAco/UJk+obJckJttwHyxNMfFVr1ADg2TDh2A+1VF5Klba2zmJ3L6DLkv+VXBUvHvvXPLxDLPnRXCzdp0wIxMeCdXZgvbFvtXB/teCOUpN0CocBkVmFtlE6uPoL74bj9l40ZqeDlHLRRbK+BS8d+0zDURINeQLFCTnvgygZof1GjfY6jbYfwfVnY9iJwjpYOc/+InPHSQJpzeVPw4c8fPK3V3rfzdwg1trpwgqnMYOFl1sr+t8ShkUiCpOBRb9E2iVM14cXbHrk3DqYO5p2pf6Ol0zeVMwAQG+oH66gGUCQT4DRcgWHFTtZtg=="
  }
}
Error Response Example: 
{
  "status": "0",
  "error": "1002",
  "msg": "Please configure the merchant public key"
}

​
5. Return parameter details description

​
tranType (Payment Type)

ValueDescription
BANK_TRANSFERBank Transfer
BANK_ACCOUNTBank Account
BANK_CARDBank Card
EWALLETE-wallet
UPIUPI

​
transaction (Transaction Type)

ValueDescription
payPayout
collectCollection

​
feeType (Fee Collection Method)

ValueDescription
0External deduction (fee deducted from balance account)
1Internal deduction (fee deducted from order amount)

​
feeMode (Fee Collection Type)

ValueDescription
0Rate
1Per transaction
2Tiered
3Floor price

​
stlMode (Settlement Method)

ValueDescription
D0Natural Day
TNWorking Day
WNWeekly Settlement
MNMonthly Settlement

​
Refund Support

Refund functionality is only supported for the following payment method combinations:
CurrencyPayment Type (payType)Payment Code (inBankCode)
USDBANK_TRANSFERCREDIT_CARD
USDEWALLETGOOGLE_PAY
USDEWALLETAPPLE_PAY
Last modified on April 17, 2026