1. Brief Description:
- Query merchant available payment configuration information based on application ID, including payment methods, fee rates, settlement periods, and other configurations
/common/payment/config
HTTP Method： POST
Content-Type： application/json
- The request requires signature verification and the signature algorithm should be consistent with other interfaces.
- tranType and tranCode are optional parameters used to filter specific types of payment configurations.
- If the application has not configured the payment product, the returned configs list will be empty.
- 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.
- If the input currency is “Cashier”, it will return all the available app payment configuration information for this user.
2. Request Parameters:
3. Response Data:
| Parameter | Type | Description |
|---|---|---|
| userId | Long | User ID |
| configs | List<PaymentConfig> | Configuration list |
| sign | String | Signature |
| Parameter | Type | Description |
|---|---|---|
| appId | Long | Application ID |
| appName | String | Application name |
| tranCode | String | tranCode type: pay=payout, collect=collection |
| tranType | String | Payment type (transaction method). See tranType |
| currNo | String | Currency code (e.g., USD) |
| payMethods | List<PayMethod> | Payment method information list |
| feeRate | FeeRate | Fee rate information |
| settlement | Settlement | Settlement period information |
| supportRefund | Boolean | Whether refund is supported, see refund support section |
| Parameter | Type | Description |
|---|---|---|
| inBankCode | String | Payment method code (inBankCode) |
| name | String | Payment method name |
| limit | Limit | Payment method limit information (intersection of t_pay_code and t_mer_app) |
| Parameter | Type | Description |
|---|---|---|
| singleMinAmount | String | Minimum single transaction amount |
| singleMaxAmount | String | Maximum single transaction amount |
FeeDegree Object:
| Parameter | Type | Description |
|---|---|---|
| start | Long | Range start |
| end | Long | Range end |
| value | String | Range value (tiered fee rate) |
| name | String | Range name |
| Parameter | Type | Description |
|---|---|---|
| stlMode | String | Settlement method. See stlMode |
| stlCycle | Integer | Settlement 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"
}
{
"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=="
}
}
{
"status": "0",
"error": "1002",
"msg": "Please configure the merchant public key"
}
5. Return parameter details description
tranType (Payment Type)
| Value | Description |
|---|---|
| BANK_TRANSFER | Bank Transfer |
| BANK_ACCOUNT | Bank Account |
| BANK_CARD | Bank Card |
| EWALLET | E-wallet |
| UPI | UPI |
transaction (Transaction Type)
| Value | Description |
|---|---|
| pay | Payout |
| collect | Collection |
feeType (Fee Collection Method)
| Value | Description |
|---|---|
| 0 | External deduction (fee deducted from balance account) |
| 1 | Internal deduction (fee deducted from order amount) |
feeMode (Fee Collection Type)
| Value | Description |
|---|---|
| 0 | Rate |
| 1 | Per transaction |
| 2 | Tiered |
| 3 | Floor price |
stlMode (Settlement Method)
| Value | Description |
|---|---|
| D0 | Natural Day |
| TN | Working Day |
| WN | Weekly Settlement |
| MN | Monthly Settlement |
Refund Support
Refund functionality is only supported for the following payment method combinations:| Currency | Payment Type (payType) | Payment Code (inBankCode) |
|---|---|---|
| USD | BANK_TRANSFER | CREDIT_CARD |
| USD | EWALLET | GOOGLE_PAY |
| USD | EWALLET | APPLE_PAY |