Card Product Creation API
Headers
Request Body Parameters
| Parameters | Parameter description with validations | Sample | Data type | Mandatory/Optional |
| productName | Name of the Product Length minimum - 10 and maximum - 50 | E.g.- BANKITPRODUCT1 | String (It can be alphanumeric , and also space accepted in the middle.) | Mandatory (for both draft case and normal product creation) |
| productDescription | Product Description Length minimum - 10 and maximum - 100 | E.g.-TEST FINO GIFT | String | Mandatory |
| productCategory | Product Category | E.g.- GIFT | String | Mandatory |
| cardType | Type of card | E.g.- MAGSTRIPE | String | Mandatory (1. For GIFTIt will be MAGSTRIPE.2. For GPR or CLOSEDLOOP It will be CHIP or CONTACTLESS.) |
| bin | Unique bin number(Length minimum - 6 and maximum - 8), It can not be decimal no. | E.g.- 818059 | String | Mandatory |
| binRange | Bin Range (if isSave is false, It can not be decimal no.) | E.g.- 58 | String | Mandatory |
| activationDate | Date from which product gets activated (It should be in dd-mm-yyyy format | E.g.- 07-04-2025 | String | Mandatory |
| expiryDate | Date at which product gets expired | E.g.- 07-04-2026 | String | Mandatory |
| termsAndCondition | Terms and condition associated with the product. | E.g.- https://firebasestorage.googleapis.com/v0/b/iserveustagingcms-bucket/o/createProduct%2FPROG9836833075%2FTESTFINOGIFT%2Fsample.pdf?alt=media&token=b11abb865937-48b8-a7c1ae1013ef7e75 | String | Mandatory |
| mccApplicable | Merchant category codes(MCC) applicable or not | E.g.-true/false | Boolean | Mandatory |
| mccCode | Merchant category code | E.g.-3550 | String | Optional |
| mccType | Merchant category code Type | E.g.- REGAL 8 INNS | String | Optional |
| mccCategory | Mcc Category | Lodging | String | Mandatory |
| mccCategoryCode | Mcc category code | 05 | String | Mandatory |
| maxLoadAmount | Maximum amount that can be loaded only taken +ve integer | (For GIFT it is between 10 to 10000 For GPR or CLOSEDLOOP it is between 1 to 200000) | String | Mandatory |
| minLoadAmount | Minimum amount that can be loaded | E.g.- 10, For GIFT it is at least 10 For GPR or CLOSEDLOOP it is at least 1 | String | Mandatory |
| maximumCardperCustomer | Maximum no. of Card per Customer | E.g. - 3 | String | Mandatory |
| cardValidity | Validity of card(in year within 1 to 5 | 2 | Integer | Mandatory, Should be an integer within 1 to 5. |
| feeCode MCC code list Array | Optional (Should be an array of objects) | |||
| feeId | Fee ID | E.g.- 4658 | String | Mandatory (it can not be decimal no.) |
| feeType | Type of fee | E.g.- Physical PIN Fee | String | Mandatory |
| feeAmount | Fee Amount | E.g.- 1 | String | Optional |
| velocityCode | Optional (Should be an array of objects. | |||
| velocityId | Velocity Id | E.g.- 4616 | Integer | Mandatory ( it can not be decimal no.) |
| velocityLimit | Velocity Limit | E.g.-1 | String | Mandatory ( it can not be decimal no.) |
| velocityCount | Velocity Count | E.g.- 1 | String | Mandatory ( it can not be decimal no.) |
| velocityType | Velocity Type | E.g.- POS_CHIP | String | Mandatory |
| isDaily | Fee Type as Daily | E.g.- false | Boolean | Mandatory |
| isWeekly | Fee Type as Weekly | E.g.- true | Boolean | Mandatory |
| isMonthly | Fee Type as Monthly | E.g.- false | Boolean | Mandatory |
| isQuarterly | Fee Type as Quarterly | E.g.- false | Boolean | Mandatory |
| isYearly | Fee Type as yearly | E.g.- false | Boolean | Mandatory |
| cardDesignLink | Card design URL | E.g.- https://firebasestorage.googleapis.com/v0/b/iserveustagingcms-bucket/o/create_product%2Fbankcard_logo.jpg?alt=media&token=9601a759f45b-4b18-af15afad2733bdbf | String | Optional |
| channel | Name of the Channel(Web/Android) | E.g.- WEB | String | Mandatory |
| maximumCardperCustomer | Max. no. of Card per Customer(Applicable for GIFT) | E.g.- 3 | String | Mandatory |
| addonDetails | Contains the following info Object | Mandatory | ||
| addonAllowed | Add-on Allowed or not | E.g.- false | Boolean | Mandatory |
| maximumaddonCardperCustomer | Maximum no. of Card per Customer, Length minimum - 1 and maximum - 50 | E.g.- 3 | String | Optional/(Mandatory if addon Allowed true) |
| replacementAddon | Addon Replacement | false | Boolean | Mandatory |
| maximumReplacementCardperCustomer | maximum Replacement Card per Customer | String | Mandatory | |
| parallelAddon | Parallel Add on | false | Boolean | Mandatory |
| maximumParallelCardPerCustomer | Maximum Parallel Card Per Customer, Length minimum - 1 and maximum - 50 | 2 | String | Optional |
| rewardsDetails Contains the following info Object | Optional | |||
| isRewardsApplicable | Rewards are Applicable or not | E.g.- true/false | Boolean | Optional |
| rewardsType | Types of rewards offered | Insurance card Insurance travel Launge access | String | Optional |
| notificationMechanisim | Mechanism to get the notification through mail or whatsapp | E.g.- email whatsapp | Array | Optional |
| remarks | Additional remarks or comments. | Remarks | String | Mandatory |
| atm Contains the following info object | Optional | |||
| atmAllowed | ATM allowed or not | E.g.-false | Boolean | Optional |
| perTransactionMaxLimit | Maximum limit allowed for transaction | E.g.- 0 | String | Optional |
| pos Contains the following info object | Mandatory | |||
| posAllowed | POS is allowed or not | E.g.-true/false | Boolean | Mandatory |
| perTransactionMaxLimit | Maximum limit allowed for POS transaction | E.g.- 1000 | String | Optional |
| ecom (ecomAllowed, perTransactionMaxLimit) | Contains following info | Object | Mandatory | |
| ecomAllowed | E-com is allowed or not | E.g.-false | Boolean | Mandatory |
| perTransactionMaxLimit | Maximum limit allowed for transaction | E.g.- 0 | String | Optional |
| imps (ipmsAllowed, perTransactionMaxLimit) | Object | Mandatory | ||
| impsAllowed | IMPS is allowed or not | E.g.- false | Boolean | Mandatory |
| perTransactionMaxLimit | Max limit for IMPS Transaction | E.g.- 0 | String | Mandatory |
| contactless (contactlessAllowed, perTransactionMaxLimit) | Contains the following info | Mandatory | ||
| contactlessAllowed | Contactless Transaction option is allowed or not | E.g.- true | Boolean | Optional |
| perTransactionMaxLimit | Max limit allowed for Transaction, (It must not exceed 2000 And less than 1) | E.g.- Yes | String | Mandatory |
| offlineAllowed | Card on OFFLINETransaction | E.g.- true/false | Boolean | Mandatory |
| reloadAllowed | Reload is allowed or not,Should be boolean (true/false) | E.g.- true | Boolean | Mandatory |
| inactiveDuration | Inactive Duration | E.g.- No | String | Mandatory |
| isSelfInventory | is Self Inventory or not | E.g.- true | Boolean | Mandatory |
| inventoryAssignedUserName | User to whom inventory is assigned | E.g.- No | Array of String | Mandatory |
| latLong | Comma separated lattitude longitude | E.g.- 19.0759837,72.8776559 | String | Mandatory |
| templateId | Unique identification number used to identify card design link | No | String | Mandatory |
| remarks | Additional remarks or comments to provide | E.g.- Product Remarks | String | Optional |
Sample Request Body
Response Body Parameters
| Parameters | Description | Data type |
| statusCode | Status Contains (0/1) | String |
| status | Status of the Operation, e.g.- SUCCESS/ FAILED | String |
| statusDesc | Description of the status | String |
Sample Response Body
SUCCESS:
FAILED:
Detailed Status Codes
| Status | Response Type | Description |
| 0 | SUCCESS | Product Created Successfully. |
| 1 | FAILED | User can not perform this action. |