Overview of the Convenience Fee response object.
Shown below is a sample response of a Calculate Convenience Fee API.
{
"data": [
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 300,
"currency": "INR"
},
"tax_amount": {
"value": 57,
"currency": "INR"
},
"additional_fee_amount": {
"value": 20,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 377,
"currency": "INR"
}
},
"payable_amount": {
"value": 10377,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN",
"card_type": "CREDIT"
}
},
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 360,
"currency": "INR"
},
"tax_amount": {
"value": 101,
"currency": "INR"
},
"additional_fee_amount": {
"value": 205,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 666,
"currency": "INR"
}
},
"payable_amount": {
"value": 10666,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "VISA",
"card_type": "CREDIT"
}
},
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 480,
"currency": "INR"
},
"tax_amount": {
"value": 122,
"currency": "INR"
},
"additional_fee_amount": {
"value": 201,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 803,
"currency": "INR"
}
},
"payable_amount": {
"value": 10803,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "MASTERCARD",
"card_type": "CREDIT"
}
},
{
"payment_method": "NETBANKING",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 400,
"currency": "INR"
},
"tax_amount": {
"value": 77,
"currency": "INR"
},
"additional_fee_amount": {
"value": 30,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 507,
"currency": "INR"
}
},
"payable_amount": {
"value": 10507,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN"
}
},
{
"payment_method": "UPI",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 600,
"currency": "INR"
},
"tax_amount": {
"value": 117,
"currency": "INR"
},
"additional_fee_amount": {
"value": 50,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 767,
"currency": "INR"
}
},
"payable_amount": {
"value": 10767,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN"
}
},
{
"payment_method": "WALLET",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 700,
"currency": "INR"
},
"tax_amount": {
"value": 136,
"currency": "INR"
},
"additional_fee_amount": {
"value": 60,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 896,
"currency": "INR"
}
},
"payable_amount": {
"value": 10896,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN"
}
},
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 900,
"currency": "INR"
},
"tax_amount": {
"value": 176,
"currency": "INR"
},
"additional_fee_amount": {
"value": 80,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 1156,
"currency": "INR"
}
},
"payable_amount": {
"value": 11156,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN",
"card_type": "DEBIT"
}
},
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 1100,
"currency": "INR"
},
"tax_amount": {
"value": 351,
"currency": "INR"
},
"additional_fee_amount": {
"value": 850,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 2301,
"currency": "INR"
}
},
"payable_amount": {
"value": 12301,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "MASTERCARD",
"card_type": "DEBIT"
}
}
]
}
{
"data": [
{
"payment_method": "CARD",
"fee_type": "PERCENTAGE",
"amount": {
"value": 10000,
"currency": "INR"
},
"convenience_fee_breakdown": {
"fee_amount": {
"value": 300,
"currency": "INR"
},
"tax_amount": {
"value": 57,
"currency": "INR"
},
"additional_fee_amount": {
"value": 20,
"currency": "INR"
},
"maximum_fee_amount": {
"value": 1500000,
"currency": "INR"
},
"applicable_fee_amount": {
"value": 377,
"currency": "INR"
}
},
"payable_amount": {
"value": 10377,
"currency": "INR"
},
"payment_method_metadata": {
"network_type": "UNKNOWN",
"card_type": "CREDIT"
}
}
]
}
The table below lists the various parameters returned in the calculate convenience fee response object.
| Parameter | Type | Description |
|---|---|---|
| payment_method | string | Type of payment method. Accepted values:
CARD |
| fee_type | string | Convenience fee type. Accepted values:
|
| amount | object | An object that contains the order amount details. Learn more about our payment_amount child object. |
| convenience_fee_breakdown | object | An object that contains the convenience fee breakdown details. Learn more about our payment_amount child object. |
| payable_amount | object | An object that contains the payable amount details. Learn more about our payment_amount child object. |
| payment_method_metadata | object | An object that contains the payment method details. Learn more about our payment_amount child object. |
Amount [Child Object]
The table below lists the various parameters in the amount child object. This object is part of the calculate convenience fee sample response object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Convenience Fee Breakdown [Child Object]
The table below lists the various parameters in the convenience_fee_breakdown child object. This object is part of the calculate convenience fee sample response object.
| Parameter | Type | Description |
|---|---|---|
| fee_amount | object | An object that contains the fee amount details. Learn more about our payment_amount child object. |
| tax_amount | object | An object that contains the tax amount details. Learn more about our payment_amount child object. |
| additional_fee_amount | object | An object that contains the additional fee amount details. Learn more about our payment_amount child object. |
| maximum_fee_amount | object | An object that contains the maximum fee amount details. Learn more about our payment_amount child object. |
| applicable_fee_amount | object | An object that contains the applicable fee amount details. Learn more about our payment_amount child object. |
Fee Amount [Child Object]
The table below lists the various parameters in the fee_amount child object. This object is part of the convenience_fee_breakdown object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Tax Amount [Child Object]
The table below lists the various parameters in the tax_amount child object. This object is part of the convenience_fee_breakdown object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Additional Fee Amount [Child Object]
The table below lists the various parameters in the additional_fee_amount child object. This object is part of the convenience_fee_breakdown object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Maximum Fee Amount [Child Object]
The table below lists the various parameters in the maximum_fee_amount child object. This object is part of the convenience_fee_breakdown object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Applicable Fee Amount [Child Object]
The table below lists the various parameters in the applicable_fee_amount child object. This object is part of the convenience_fee_breakdown object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Payable Amount [Child Object]
The table below lists the various parameters in the payable_amount child object. This object is part of the calculate convenience fee sample response object.
| Parameter | Type | Description |
|---|---|---|
| value | integer | The transaction amount is Paisa.
100 |
| currency | string | Type of currency. Example: INR |
Payment Method Metadata [Child Object]
The table below lists the various parameters in the payment_method_metadata child object. This object is part of the calculate convenience fee sample response object.
| Parameter | Type | Description |
|---|---|---|
| network_type | integer | Type of network. Example: MASTERCARD |
| card_type | string | Type of card. Example: DEBIT |