{ "openapi": "3.1.0", "info": { "title": "Flamingo Merchant API", "version": "1.0" }, "servers": [ { "url": "https://vpdemo.valorpaytech.com/" } ], "components": { "securitySchemes": { } }, "security": [ { } ], "paths": { "/api/valor/login": { "post": { "summary": "Merchant - Create Bearer Token", "description": "", "operationId": "merchant-create-bearer-token", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "mailId", "SubmailId", "passCode" ], "properties": { "mailId": { "type": "string", "description": "E-mail id of the iso office - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "demovaloriso" }, "SubmailId": { "type": "string", "description": "Submail / the username of the sub office - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "demovaloriso" }, "passCode": { "type": "string", "description": "The password of the office login on which the merchant to be boarded", "default": "Valor@123" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": {\n \"user_id\": 39623,\n \"userType_id\": 2,\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc\"\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "user_id": { "type": "integer", "example": 39623, "default": 0 }, "userType_id": { "type": "integer", "example": 2, "default": 0 }, "access_token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Invalid password\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Invalid password" }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/create?surcharge": { "post": { "summary": "Merchant Add - Surcharge (Tsys)", "description": "", "operationId": "merchant-add-surcharge-tsys", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoyMzk3LCJ1c2VyX3R5cGVfaWQiOjIsInBlcm1pc3Npb25zIjpbIm1vZHVsZXM6KiIsInVzZXI6aXNvIl0sInNlc3Npb25faWQiOiJiYjY5MDc3NC1lMjk1LTQyMGUtODhkNC05ZTVmMWUxN2RjNDgiLCJpYXQiOjE3MDIwMTgxNDcsImV4cCI6MTcwMjA0Njk0N30.LAZfwxM9KK0_J0VubM-xS0u8P0iccm32PwVX_Ji_wrg" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "legalName", "dbaName", "firstName", "lastName", "ownerName", "emailId", "userName", "mobile", "legalAddress", "legalCity", "legalState", "legalCountry", "legalZipCode", "legalTimezone", "userType", "isTxnAllowed", "businessType", "storeData", "moduleList", "selectedState", "processor", "programType", "rollUp" ], "properties": { "legalName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: Quick book dba, Valor Cafe )", "default": "Valor Store" }, "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "Valor Store LLC" }, "firstName": { "type": "string", "description": "Max length is 15 char - varchar (First name of the Mechant)", "default": "MERCHANT" }, "lastName": { "type": "string", "description": "Max length is 15 char - varchar (Last name of the Mechant)", "default": "PORTAL" }, "ownerName": { "type": "string", "description": "Boarded by ISO & Sub-ISO name - varchar", "default": "MERCHANT PORTAL" }, "emailId": { "type": "string", "description": "Merchant email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "name@protonmail.com" }, "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 35 chars)", "default": "merchat310823" }, "mobile": { "type": "string", "description": "Merchnat phone number- 10 digit Numeric (Ex: 5247896523)", "default": "8327287578" }, "legalAddress": { "type": "string", "description": "Legal Address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "legalCity": { "type": "string", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "legalState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "legalCountry": { "type": "string", "description": "Legal country should be mention default set us US", "default": "US" }, "legalZipCode": { "type": "string", "description": "Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07010" }, "legalTimezone": { "type": "string", "description": "Time zone (3 char eg: EST, AST ,PST, HST, MST)", "default": "EST" }, "role": { "type": "integer", "description": "Should be set as '10' it is related to role of Merchant", "default": 10, "format": "int32" }, "userType": { "type": "integer", "description": "Should be set as '4' - User type for the merchant", "default": 4, "format": "int32" }, "isTxnAllowed": { "type": "integer", "description": "Should be set isTxnAllowed default as '1'", "default": 1, "format": "int32" }, "businessType": { "type": "string", "description": "Should be sent as business type (varchar - Ex: Retail, Direct Marketing)", "default": "Direct Marketing" }, "storeData": { "type": "array", "items": { "properties": { "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "EL TRI MX RESTA Add" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "4100 JOHNSTON ST" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "LAFAYETTE" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "LA" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "70503" }, "storeTimezone": { "type": "string", "description": "Store time zone (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "EL TRI MX RESTA" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "office@valorpaytech.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "3377040344" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "5812" }, "descriptors": { "type": "array", "description": "It should be 25 chars", "default": [], "items": { "type": "string" } }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft POS" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "1" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "batch_number": { "type": "string" }, "features": { "type": "object", "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } } }, "processorData": { "type": "array", "items": { "properties": { "mid": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "887000003193" }, "mid1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "\"\"", "format": "json" }, "vNumber": { "type": "string", "description": "vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "75021674" }, "vNumber1": { "type": "string", "description": "vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "storeNo": { "type": "string", "description": "Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "5999" }, "storeNo1": { "type": "string", "description": "Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "termNo": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "1515" }, "termNo1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "association": { "type": "string", "description": "Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "949006" }, "association1": { "type": "string", "description": "Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "chain": { "type": "string", "description": "Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "111111" }, "chain1": { "type": "string", "description": "Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agent": { "type": "string", "description": "Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "0001" }, "agent1": { "type": "string", "description": "Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber": { "type": "string", "description": "Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "999991" }, "binnumber1": { "type": "string", "description": "Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agentBank": { "type": "string", "description": "Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "000000" }, "agentBank1": { "type": "string", "description": "Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "industry": { "type": "string", "description": "The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "Retail" }, "industry1": { "type": "string", "description": "The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EBTcash": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "4.00" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "MERCHANT PORTAL LOGIN" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "mid", "mid1", "vNumber", "vNumber1", "storeNo", "storeNo1", "termNo", "association", "association1", "chain", "chain1", "agent", "agent1", "EbtNo", "EbtNo1", "binnumber", "binnumber1", "agentBank", "agentBank1", "industry", "industry1", "EBTcash", "EBTcash1", "EBTfood1", "surchargeIndicator", "surchargePercentage", "label", "programType" ], "type": "object" } }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NJ" } }, "required": [ "device", "deviceType", "processor", "epiLabel", "selectedState" ], "type": "object" } } }, "required": [ "storeName", "storeAddress", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "mccCode" ], "type": "object" } }, "moduleList": { "type": "array", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EModule\u003C/th\u003E \u003Cth\u003EModule ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EUser Management\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETransactions\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESettings\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E14\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDevice Management\u003C/td\u003E \u003Ctd\u003E15\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EEngage My Customers\u003C/td\u003E \u003Ctd\u003E17\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPromotions\u003C/td\u003E \u003Ctd\u003E18\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EValor Shield RT\u003C/td\u003E \u003Ctd\u003E19\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EContact Us\u003C/td\u003E \u003Ctd\u003E20\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESupport\u003C/td\u003E \u003Ctd\u003E24\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EMy Tickets\u003C/td\u003E \u003Ctd\u003E25\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVault\u003C/td\u003E \u003Ctd\u003E29\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": [1, 3, 6, 14, 15, 17, 18, 19, 20, 24, 25, 29], "items": { "type": "integer", "format": "int32" } }, "selectedState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "processor": { "type": "string", "description": "Update the processor params 1 (TSYS - 1)", "default": "1" }, "programType": { "type": "string", "description": "1 (cash discount) or 2 (traditional)", "default": "1" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "0" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" }, "ActivationNotification": { "type": "boolean", "description": "If the ActivationNotification is set to true, it indicates that an activation email will be sent to the merchant. If set to false, it means that no activation email will be sent." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/create?fdSurcharge": { "post": { "summary": "Merchant Add - Surcharge (FD)", "description": "", "operationId": "merchant-add-surcharge-fd-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "legalName", "dbaName", "firstName", "lastName", "ownerName", "emailId", "userName", "mobile", "legalAddress", "legalCity", "legalState", "legalCountry", "legalZipCode", "legalTimezone", "role", "userType", "isTxnAllowed", "businessType", "storeData", "moduleList", "selectedState", "programType", "processor", "rollUp" ], "properties": { "legalName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: Quick book dba, Valor Cafe )", "default": "Valor Store" }, "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "Valor Store LLC" }, "firstName": { "type": "string", "description": "Max length is 15 char - varchar (First name of the Mechant)", "default": "MERCHANT" }, "lastName": { "type": "string", "description": "Max length is 15 char - varchar (Last name of the Mechant)", "default": "PORTAL" }, "ownerName": { "type": "string", "description": "Boarded by ISO & Sub-ISO name - varchar", "default": "Boarded by name" }, "emailId": { "type": "string", "description": "Merchant email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "name@protonmail.com" }, "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 35 chars)", "default": "merchat310823" }, "mobile": { "type": "string", "description": "Merchant phone number- 10 digit Numeric (Ex: 5247896523)", "default": "8327287578" }, "legalAddress": { "type": "string", "description": "Legal Address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "legalCity": { "type": "string", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "legalState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "legalCountry": { "type": "string", "description": "Legal country should be mention default set us US", "default": "US" }, "legalZipCode": { "type": "string", "description": "Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07000" }, "legalTimezone": { "type": "string", "description": "Time zone (3 char eg: EST, AST ,PST, HST, MST)", "default": "EST" }, "role": { "type": "string", "description": "Should be set as '10' it is related to role of Merchant", "default": "10" }, "userType": { "type": "string", "description": "Should be set as '4' - User type for the merchant", "default": "4" }, "isTxnAllowed": { "type": "string", "description": "Should be set isTxnAllowed default as '1'", "default": "1" }, "businessType": { "type": "string", "description": "Should be sent as business type (varchar - Ex: Retail, Direct Marketing)", "default": "Direct Marketing" }, "storeData": { "type": "array", "items": { "properties": { "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "EL TRI MX RESTA Add" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "20987 N John Wayne Pkwy" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "MARICOPA" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "AZ" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "85138" }, "storeTimezone": { "type": "string", "description": "Store time zone (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "EL TRI MX RESTA" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "office@valorpaytech.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "5208396263" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "1761" }, "descriptors": { "type": "array", "description": "It should be max length 100 chars", "default": [], "items": { "type": "string" } }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100,VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft Pos" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "2" }, "batch_number": { "type": "string" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "features": { "type": "array", "items": { "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } }, "type": "object" } }, "processorData": { "type": "array", "items": { "properties": { "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "3.846" }, "groupId": { "type": "string", "description": "Group id to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "40001" }, "groupId1": { "type": "string", "description": "Group id to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "midFD": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "RCTST0000050635" }, "midFD1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "\"\"", "format": "json" }, "termNoFD": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "OM134524" }, "termNoFD1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNoFD": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile", "default": "\"\"", "format": "json" }, "EbtNoFD1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile", "default": "\"\"", "format": "json" }, "website": { "type": "string", "description": "Website name for surcharge profile", "default": "\"\"", "format": "json" }, "website1": { "type": "string", "description": "Website name for traditional profile", "default": "\"\"", "format": "json" }, "mid3": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "termNo3": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "location_id": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "client_key": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "c_name": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "EBTfood": { "type": "integer", "description": "EBT food related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 1, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "EBT food related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash": { "type": "integer", "description": "EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "EBT cash related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "UNIVERSAL ROOFING SPECIALISTS" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "surchargePercentage", "groupId", "groupId1", "midFD", "midFD1", "termNoFD", "termNoFD1", "EbtNoFD", "EbtNoFD1", "website", "website1", "mid3", "termNo3", "location_id", "client_key", "c_name", "EBTfood", "EBTfood1", "EBTcash", "EBTcash1", "surchargeIndicator", "label", "programType" ], "type": "object" } } }, "required": [ "device", "deviceType", "processor", "epiLabel" ], "type": "object" } } }, "required": [ "storeName", "storeAddress", "storeCity", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "superVisorContact", "mccCode" ], "type": "object" } }, "moduleList": { "type": "array", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EModule\u003C/th\u003E \u003Cth\u003EModule ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EUser Management\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETransactions\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESettings\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E14\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDevice Management\u003C/td\u003E \u003Ctd\u003E15\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EEngage My Customers\u003C/td\u003E \u003Ctd\u003E17\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPromotions\u003C/td\u003E \u003Ctd\u003E18\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EValor Shield RT\u003C/td\u003E \u003Ctd\u003E19\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EContact Us\u003C/td\u003E \u003Ctd\u003E20\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESupport\u003C/td\u003E \u003Ctd\u003E24\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EMy Tickets\u003C/td\u003E \u003Ctd\u003E25\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVault\u003C/td\u003E \u003Ctd\u003E29\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": [1, 3, 6, 14, 15, 17, 18, 19, 20, 24, 25, 29], "items": { "type": "integer", "format": "int32" } }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NY" }, "programType": { "type": "string", "description": "1 (cash discount) or 2 (traditional)", "default": "1" }, "processor": { "type": "string", "description": "Update the processor params 2 (FD - 2)", "default": "2" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "0" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" }, "ActivationNotification": { "type": "boolean", "description": "If the ActivationNotification is set to true, it indicates that an activation email will be sent to the merchant. If set to false, it means that no activation email will be sent." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/create": { "post": { "summary": "Merchant Add - Traditional (Tsys)", "description": "", "operationId": "merchant-add-traditional-tsys", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "legalName", "dbaName", "firstName", "lastName", "ownerName", "emailId", "userName", "mobile", "legalCity", "legalAddress", "legalState", "legalCountry", "legalZipCode", "legalTimezone", "role", "userType", "businessType", "moduleList", "selectedState", "processor", "rollUp", "programType" ], "properties": { "legalName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: Quick book dba, Valor Cafe )", "default": "Valor Store" }, "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "Valor Store LLC" }, "firstName": { "type": "string", "description": "Max length is 15 char - varchar (First name of the Mechant)", "default": "MERCHANT" }, "lastName": { "type": "string", "description": "Max length is 15 char - varchar (Last name of the Mechant)", "default": "PORTAL" }, "ownerName": { "type": "string", "description": "Boarded by ISO & Sub-ISO name - varchar", "default": "MERCHANT PORTAL" }, "emailId": { "type": "string", "description": "Merchant email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "name@protonmail.com" }, "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 35 chars)", "default": "merchat310823" }, "mobile": { "type": "string", "description": "Mobile number of the merchant,max length is 10 digit", "default": "8327287578" }, "legalCity": { "type": "string", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "legalAddress": { "type": "string", "description": "Legal Address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "legalState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "legalCountry": { "type": "string", "description": "Legal country should be mention default set us US", "default": "US" }, "legalZipCode": { "type": "string", "description": "Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07010" }, "legalTimezone": { "type": "string", "description": "Time zone (3 char eg: EST, AST ,PST, HST, MST)", "default": "EST" }, "role": { "type": "string", "description": "Should be set as '10' it is related to role of Merchant", "default": "10" }, "userType": { "type": "string", "description": "Should be set as '4' - User type for the merchant", "default": "4" }, "isTxnAllowed": { "type": "string", "description": "Should be set isTxnAllowed default as '1'", "default": "1" }, "businessType": { "type": "string", "description": "Should be sent as business type (varchar - Ex: Retail, Direct Marketing)", "default": "Direct Marketing" }, "storeData": { "type": "array", "items": { "properties": { "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "Village Organic Convenience" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "170 7th Ave S" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "NEW YORK" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NY" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "10014" }, "storeTimezone": { "type": "string", "description": "Store time zone (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "Village Organic Convenience Corp" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "valorbaseadmin@protonmail.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "2124637932" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "5993" }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "integer", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 139, "format": "int32" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft Pos" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "batch_number": { "type": "string" }, "features": { "type": "object", "description": "In this feature can enable tip, settlement, paytable, ebt, seccom, signaturecab and surcharge", "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } } }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS : 1 and FD : 2)", "default": "1" }, "processorData": { "type": "array", "items": { "properties": { "mid": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "\"\"", "format": "json" }, "mid1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "887000003193" }, "vNumber": { "type": "string", "description": "vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "\"\"", "format": "json" }, "vNumber1": { "type": "string", "description": "vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "75021674" }, "storeNo": { "type": "string", "description": "Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "storeNo1": { "type": "string", "description": "Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "5999" }, "termNo": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "termNo1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "1515" }, "association": { "type": "string", "description": "Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "association1": { "type": "string", "description": "Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "949006" }, "chain": { "type": "string", "description": "Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "chain1": { "type": "string", "description": "Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "111111" }, "agent": { "type": "string", "description": "Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "agent1": { "type": "string", "description": "Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "0001" }, "EbtNo": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber": { "type": "string", "description": "Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber1": { "type": "string", "description": "Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "999991" }, "agentBank": { "type": "string", "description": "Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "agentBank1": { "type": "string", "description": "Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "000001" }, "industry": { "type": "string", "description": "The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "industry1": { "type": "string", "description": "The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as \"null\"", "default": "Direct Marketing" }, "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "\"\"" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "EBTfood": { "type": "integer", "description": "EBT food related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "EBT food related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash": { "type": "integer", "description": "EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "EBT cash related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "MERCHANT PORTAL LOGIN" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "mid", "mid1", "vNumber", "vNumber1", "storeNo", "storeNo1", "termNo", "termNo1", "association", "association1", "chain", "chain1", "agent", "agent1", "EbtNo", "EbtNo1", "binnumber", "binnumber1", "agentBank", "agentBank1", "industry", "industry1", "surchargePercentage", "surchargeIndicator", "EBTfood", "EBTfood1", "EBTcash", "EBTcash1", "label", "programType" ], "type": "object" } } }, "required": [ "device", "deviceType", "epiLabel", "processor" ], "type": "object" } }, "descriptors": { "type": "array", "description": "It should be max length 100 chars", "default": [], "items": { "type": "string" } } }, "required": [ "storeName", "storeAddress", "storeCity", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "superVisorContact", "mccCode", "descriptors" ], "type": "object" } }, "moduleList": { "type": "array", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EModule\u003C/th\u003E \u003Cth\u003EModule ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EUser Management\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETransactions\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESettings\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E14\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDevice Management\u003C/td\u003E \u003Ctd\u003E15\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EEngage My Customers\u003C/td\u003E \u003Ctd\u003E17\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPromotions\u003C/td\u003E \u003Ctd\u003E18\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EValor Shield RT\u003C/td\u003E \u003Ctd\u003E19\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EContact Us\u003C/td\u003E \u003Ctd\u003E20\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESupport\u003C/td\u003E \u003Ctd\u003E24\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EMy Tickets\u003C/td\u003E \u003Ctd\u003E25\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVault\u003C/td\u003E \u003Ctd\u003E29\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": [1, 3, 6, 14, 15, 17, 18, 19, 20, 24, 25, 29], "items": { "type": "integer", "format": "int32" } }, "selectedState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "processor": { "type": "string", "description": "Update the processor params 1 (TSYS - 1)", "default": "1" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "1" }, "programType": { "type": "string", "description": "1 (cash discount) or 2 (traditional)", "default": "2" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" }, "ActivationNotification": { "type": "boolean", "description": "If the ActivationNotification is set to true, it indicates that an activation email will be sent to the merchant. If set to false, it means that no activation email will be sent." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/create?FDtraditional": { "post": { "summary": "Merchant Add - Traditional (FD)", "description": "", "operationId": "merchant-add-traditional-fd", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "legalName", "dbaName", "firstName", "lastName", "ownerName", "emailId", "userName", "mobile", "legalAddress", "legalCity", "legalState", "legalCountry", "legalZipCode", "legalTimezone", "role", "userType", "isTxnAllowed", "businessType", "storeData", "moduleList", "selectedState", "programType", "processor", "rollUp" ], "properties": { "legalName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: Quick book dba, Valor Cafe )", "default": "Valor Store" }, "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "Valor Store LLC" }, "firstName": { "type": "string", "description": "Max length is 15 char - varchar (First name of the Mechant)", "default": "MERCHANT" }, "lastName": { "type": "string", "description": "Max length is 15 char - varchar (Last name of the Mechant)", "default": "PORTAL" }, "ownerName": { "type": "string", "description": "Boarded by ISO & Sub-ISO name - varchar", "default": "MERCHANT PORTAL" }, "emailId": { "type": "string", "description": "Merchant email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "name@protonmail.com" }, "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 35 chars)", "default": "merchat310823" }, "mobile": { "type": "string", "description": "Merchant phone number- 10 digit Numeric (Ex: 5247896523)", "default": "8327287578" }, "legalAddress": { "type": "string", "description": "Legal Address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "legalCity": { "type": "string", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "legalState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "legalCountry": { "type": "string", "description": "Legal country should be mention default set us US", "default": "US" }, "legalZipCode": { "type": "string", "description": "Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07000" }, "legalTimezone": { "type": "string", "description": "Time zone (3 char eg: EST, AST ,PST, HST, MST)", "default": "EST" }, "role": { "type": "string", "description": "Should be set as '10' it is related to role of Merchant", "default": "10" }, "userType": { "type": "string", "description": "Should be set as '4' - User type for the merchant", "default": "4" }, "isTxnAllowed": { "type": "string", "description": "Should be set isTxnAllowed default as '1'", "default": "1" }, "businessType": { "type": "string", "description": "Should be sent as business type (varchar - Ex: Retail, Direct Marketing)", "default": "Direct Marketing" }, "storeData": { "type": "array", "items": { "properties": { "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "EL TRI MX RESTA Add" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "20987 N John Wayne Pkwy" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "MARICOPA" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "AZ" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "50001" }, "storeTimezone": { "type": "string", "description": "Store time zone (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "EL TRI MX RESTA" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "office@valorpaytech.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "5208396263" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "1761" }, "descriptors": { "type": "array", "description": "It should be max length 100 chars", "default": [], "items": { "type": "string" } }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft Pos" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "2" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "batch_number": { "type": "string" }, "features": { "type": "object", "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } } }, "processorData": { "type": "array", "items": { "properties": { "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "groupId": { "type": "string", "description": "Group id to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "\"\"", "format": "json" }, "groupId1": { "type": "string", "description": "Group id to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "40001" }, "midFD": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "\"\"", "format": "json" }, "midFD1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "5101657702040630" }, "termNoFD": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "termNoFD1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "OM134524" }, "EbtNoFD": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile", "default": "\"\"", "format": "json" }, "EbtNoFD1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile", "default": "\"\"", "format": "json" }, "website": { "type": "string", "description": "Website name for surcharge profile", "default": "\"\"", "format": "json" }, "website1": { "type": "string", "description": "Website name for traditional profile", "default": "\"\"", "format": "json" }, "mid3": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "termNo3": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "location_id": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "client_key": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "c_name": { "type": "string", "description": "Always set as Null", "default": "\"\"", "format": "json" }, "label": { "type": "string", "description": "The store name on which the device/terminal created is mapped on this field", "default": "UNIVERSAL ROOFING SPECIALISTS" }, "EBTfood": { "type": "integer", "description": "EBT food related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "EBT food related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash": { "type": "integer", "description": "EBT cash related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "EBT cash related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "surchargePercentage", "groupId", "groupId1", "midFD", "midFD1", "termNoFD", "termNoFD1", "EbtNoFD", "EbtNoFD1", "website", "website1", "mid3", "termNo3", "location_id", "client_key", "c_name", "label", "EBTfood", "EBTfood1", "EBTcash", "EBTcash1", "surchargeIndicator", "programType" ], "type": "object" } } }, "required": [ "device", "deviceType", "processor", "epiLabel" ], "type": "object" } } }, "required": [ "storeName", "storeAddress", "storeCity", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "superVisorContact", "descriptors" ], "type": "object" } }, "moduleList": { "type": "array", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EModule\u003C/th\u003E \u003Cth\u003EModule ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EUser Management\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETransactions\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESettings\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E14\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDevice Management\u003C/td\u003E \u003Ctd\u003E15\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EEngage My Customers\u003C/td\u003E \u003Ctd\u003E17\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPromotions\u003C/td\u003E \u003Ctd\u003E18\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EValor Shield RT\u003C/td\u003E \u003Ctd\u003E19\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EContact Us\u003C/td\u003E \u003Ctd\u003E20\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ESupport\u003C/td\u003E \u003Ctd\u003E24\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EMy Tickets\u003C/td\u003E \u003Ctd\u003E25\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVault\u003C/td\u003E \u003Ctd\u003E29\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": [1, 3, 6, 14, 15, 17, 18, 19, 20, 24, 25, 29], "items": { "type": "integer", "format": "int32" } }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NY" }, "programType": { "type": "string", "description": "1 (cash discount) or 2 (traditional)", "default": "2" }, "processor": { "type": "string", "description": "Update the processor params 2 (FD - 2)", "default": "2" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "0" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" }, "ActivationNotification": { "type": "boolean", "description": "If the ActivationNotification is set to true, it indicates that an activation email will be sent to the merchant. If set to false, it means that no activation email will be sent." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/copyParameter": { "post": { "summary": "Copy Parameter API", "description": "", "operationId": "copy-parameter-api", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source_epi", "destination_epi" ], "properties": { "source_epi": { "type": "string", "description": "Source EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319931361" }, "destination_epi": { "type": "string", "description": "Destination EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319931360" }, "associate_user_name": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/getViewMerchantProfile": { "post": { "summary": "Merchant Get Details", "description": "", "operationId": "merchant-view-2", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiY2VjZTk2YTItMzJiNC00NjVjLTg5M2QtZTMwZGM5YTAzOGU1IiwiaWF0IjoxNzMxOTk5MDgxLCJleHAiOjE3MzIwMjc4ODF9.k8Iz1ewmQcEOFvhH9sG5k4Lq-zV7-xPT0l-gDZFWiLw" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "UserId" ], "properties": { "UserId": { "type": "string", "description": "Merchant new user ID (Max length of 11 chars)", "default": "70871" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/checkmail": { "post": { "summary": "Check Credential", "description": "", "operationId": "check-credential", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiY2VjZTk2YTItMzJiNC00NjVjLTg5M2QtZTMwZGM5YTAzOGU1IiwiaWF0IjoxNzMxOTk5MDgxLCJleHAiOjE3MzIwMjc4ODF9.k8Iz1ewmQcEOFvhH9sG5k4Lq-zV7-xPT0l-gDZFWiLw" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userName" ], "properties": { "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 25 chars)", "default": "merchat19112445" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"code\": \"400\",\n \"Mp_id\": 28172,\n \"newUserId\": 50931,\n \"StoreID\": 32089,\n \"UserType_Id\": 4,\n \"message\": \"User Name Already Exists\",\n \"StatusUser\": 2\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "string", "example": "400" }, "Mp_id": { "type": "integer", "example": 28172, "default": 0 }, "newUserId": { "type": "integer", "example": 50931, "default": 0 }, "StoreID": { "type": "integer", "example": 32089, "default": 0 }, "UserType_Id": { "type": "integer", "example": 4, "default": 0 }, "message": { "type": "string", "example": "User Name Already Exists" }, "StatusUser": { "type": "integer", "example": 2, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"code\": \"200\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "string", "example": "200" } } } } } } }, "deprecated": false } }, "/api/valor/deletestore": { "post": { "summary": "Store Delete", "description": "", "operationId": "store-delete-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiY2VjZTk2YTItMzJiNC00NjVjLTg5M2QtZTMwZGM5YTAzOGU1IiwiaWF0IjoxNzMxOTk5MDgxLCJleHAiOjE3MzIwMjc4ODF9.k8Iz1ewmQcEOFvhH9sG5k4Lq-zV7-xPT0l-gDZFWiLw" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "store_id" ], "properties": { "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 25 chars)", "default": "merchat19112445" }, "store_id": { "type": "array", "description": "Merchant store Id (Max length of chars 11)", "default": [47726], "items": { "type": "integer", "format": "int32" } }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" }, "isv-secret-key": { "type": "string", "description": "ISV secret key" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": \"Deleted Sucessfully\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "string", "example": "Deleted Sucessfully" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": \"Store Not exists.\"\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "string", "example": "Store Not exists." } } } } } } }, "deprecated": false } }, "/api/valor/deleteepi": { "post": { "summary": "EPI Delete", "description": "", "operationId": "epi-delete-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiY2VjZTk2YTItMzJiNC00NjVjLTg5M2QtZTMwZGM5YTAzOGU1IiwiaWF0IjoxNzMxOTk5MDgxLCJleHAiOjE3MzIwMjc4ODF9.k8Iz1ewmQcEOFvhH9sG5k4Lq-zV7-xPT0l-gDZFWiLw" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userName", "epi_id" ], "properties": { "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 25 chars)", "default": "merchat19112445erer" }, "epi_id": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930871" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/getepidetails": { "post": { "summary": "EPI View", "description": "", "operationId": "get-epi", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZjA5Yjg4YTEtZTc0Ni00NTlkLWE0ZDYtODcyNjc3NWVlMTI3IiwiaWF0IjoxNzMzMjEyMzU5LCJleHAiOjE3MzMyNDExNTl9.pQDWAyyA1opea22QnUWMb1ih5f525apHv-KvHkThTx8" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "mp_id" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319931361" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43919" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": {\n \"id\": 28177,\n \"userId\": 50941,\n \"parentId\": 23013,\n \"dbaName\": \"Valor Store LLC\",\n \"legalName\": \"Valor Store\",\n \"firstName\": \"MERCHANT\",\n \"lastName\": \"PORTAL\",\n \"ownerName\": \"Dineshwar ISO\",\n \"emailId\": \"name@protonmail.com\",\n \"mobile\": \"8327287578\",\n \"legalAddress\": \"Test Address\",\n \"legalCity\": \"CLIFFSIDE PARK\",\n \"legalState\": \"28\",\n \"selectedState\": \"28\",\n \"legalCountry\": \"US\",\n \"legalZipCode\": \"07010\",\n \"legalTimezone\": \"EST\",\n \"logo\": \"MERCHANT\",\n \"role\": 10,\n \"userType\": 4,\n \"isTxnAllowed\": 1,\n \"businessType\": \"10\",\n \"sicCode\": \"0742 - VETERINARY SERVICE\",\n \"storeData\": []\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "integer", "example": 28177, "default": 0 }, "userId": { "type": "integer", "example": 50941, "default": 0 }, "parentId": { "type": "integer", "example": 23013, "default": 0 }, "dbaName": { "type": "string", "example": "Valor Store LLC" }, "legalName": { "type": "string", "example": "Valor Store" }, "firstName": { "type": "string", "example": "MERCHANT" }, "lastName": { "type": "string", "example": "PORTAL" }, "ownerName": { "type": "string", "example": "Dineshwar ISO" }, "emailId": { "type": "string", "example": "name@protonmail.com" }, "mobile": { "type": "string", "example": "8327287578" }, "legalAddress": { "type": "string", "example": "Test Address" }, "legalCity": { "type": "string", "example": "CLIFFSIDE PARK" }, "legalState": { "type": "string", "example": "28" }, "selectedState": { "type": "string", "example": "28" }, "legalCountry": { "type": "string", "example": "US" }, "legalZipCode": { "type": "string", "example": "07010" }, "legalTimezone": { "type": "string", "example": "EST" }, "logo": { "type": "string", "example": "MERCHANT" }, "role": { "type": "integer", "example": 10, "default": 0 }, "userType": { "type": "integer", "example": 4, "default": 0 }, "isTxnAllowed": { "type": "integer", "example": 1, "default": 0 }, "businessType": { "type": "string", "example": "10" }, "sicCode": { "type": "string", "example": "0742 - VETERINARY SERVICE" }, "storeData": { "type": "array" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Please Enter epi\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Please Enter epi" }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/checkprofile": { "post": { "summary": "Check Profile", "description": "", "operationId": "check-profile", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "newUserId", "mp_id", "store_id" ], "properties": { "newUserId": { "type": "string", "description": "Merchant User ID (Max length of 11 chars)", "default": "70979" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43019" }, "store_id": { "type": "string", "description": "Merchant store Id (Max length of chars 11)", "default": "47831" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"code\": \"200\",\n \"Mp_id\": 28177,\n \"newUserId\": 50941,\n \"StoreID\": 32094,\n \"message\": \"Profile Data Exits\",\n \"StatusUser\": 2\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "string", "example": "200" }, "Mp_id": { "type": "integer", "example": 28177, "default": 0 }, "newUserId": { "type": "integer", "example": 50941, "default": 0 }, "StoreID": { "type": "integer", "example": 32094, "default": 0 }, "message": { "type": "string", "example": "Profile Data Exits" }, "StatusUser": { "type": "integer", "example": 2, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"code\": \"200\",\n \"message\": \"Profile Data Not Exits\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "string", "example": "200" }, "message": { "type": "string", "example": "Profile Data Not Exits" } } } } } } }, "deprecated": false } }, "/api/valor/checkvnumber": { "post": { "summary": "Check V Number", "description": "", "operationId": "check-v-number", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "vnumber" ], "properties": { "vnumber": { "type": "string", "default": "75009549" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"code\": \"200\",\n \"Mp_id\": 596,\n \"newUserId\": 1087,\n \"StoreID\": 992,\n \"epi\": \"2002527539\",\n \"processor_params\": \"{\\\"surchargelabel\\\":\\\"323\\\",\\\"nosurchargelabel\\\":\\\"\\\",\\\"mid\\\":\\\"886000000072\\\",\\\"mid1\\\":\\\"\\\",\\\"vNumber\\\":\\\"75009549\\\",\\\"vNumber1\\\":\\\"\\\",\\\"storeNo\\\":\\\"1076\\\",\\\"storeNo1\\\":\\\"\\\",\\\"termNo\\\":\\\"1076\\\",\\\"termNo1\\\":\\\"\\\",\\\"association\\\":\\\"\\\",\\\"association1\\\":\\\"\\\",\\\"chain\\\":\\\"949006\\\",\\\"chain1\\\":\\\"\\\",\\\"agent\\\":\\\"0000\\\",\\\"agent1\\\":\\\"\\\",\\\"EbtNo\\\":\\\"0000000\\\",\\\"EbtNo1\\\":\\\"0000000\\\",\\\"binnumber\\\":\\\"686868\\\",\\\"binnumber1\\\":\\\"\\\",\\\"label\\\":\\\"ISO ACCESS PVT LTD\\\",\\\"id\\\":1588,\\\"c_name\\\":\\\"\\\",\\\"surchargePercentage\\\":\\\"3.000\\\",\\\"agentBank1\\\":\\\"\\\",\\\"industry1\\\":\\\"\\\",\\\"c_name3\\\":1,\\\"c_nameFD3\\\":\\\"\\\",\\\"tid3\\\":\\\"1231232323\\\",\\\"tidFD3\\\":\\\"\\\",\\\"clientID\\\":\\\"asdsadfasdfasdfd\\\",\\\"clientID_FD\\\":\\\"\\\",\\\"clientID_FDCard\\\":\\\"\\\",\\\"clientID_FDBuy\\\":\\\"\\\",\\\"clientID_FDNash\\\":\\\"\\\",\\\"EBTfood1\\\":0,\\\"EBTcash1\\\":0,\\\"EBTfood\\\":0,\\\"EBTcash\\\":0}\",\n \"message\": \"Profile Data Exits\",\n \"StatusUser\": 1\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "string", "example": "200" }, "Mp_id": { "type": "integer", "example": 596, "default": 0 }, "newUserId": { "type": "integer", "example": 1087, "default": 0 }, "StoreID": { "type": "integer", "example": 992, "default": 0 }, "epi": { "type": "string", "example": "2002527539" }, "processor_params": { "type": "string", "example": "{\"surchargelabel\":\"323\",\"nosurchargelabel\":\"\",\"mid\":\"886000000072\",\"mid1\":\"\",\"vNumber\":\"75009549\",\"vNumber1\":\"\",\"storeNo\":\"1076\",\"storeNo1\":\"\",\"termNo\":\"1076\",\"termNo1\":\"\",\"association\":\"\",\"association1\":\"\",\"chain\":\"949006\",\"chain1\":\"\",\"agent\":\"0000\",\"agent1\":\"\",\"EbtNo\":\"0000000\",\"EbtNo1\":\"0000000\",\"binnumber\":\"686868\",\"binnumber1\":\"\",\"label\":\"ISO ACCESS PVT LTD\",\"id\":1588,\"c_name\":\"\",\"surchargePercentage\":\"3.000\",\"agentBank1\":\"\",\"industry1\":\"\",\"c_name3\":1,\"c_nameFD3\":\"\",\"tid3\":\"1231232323\",\"tidFD3\":\"\",\"clientID\":\"asdsadfasdfasdfd\",\"clientID_FD\":\"\",\"clientID_FDCard\":\"\",\"clientID_FDBuy\":\"\",\"clientID_FDNash\":\"\",\"EBTfood1\":0,\"EBTcash1\":0,\"EBTfood\":0,\"EBTcash\":0}" }, "message": { "type": "string", "example": "Profile Data Exits" }, "StatusUser": { "type": "integer", "example": 1, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Error\",\n \"data\": {\n \"errors\": {\n \"error\": \"Please Enter vnumber\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Error" }, "data": { "type": "object", "properties": { "errors": { "type": "object", "properties": { "error": { "type": "string", "example": "Please Enter vnumber" } } } } } } } } } } }, "deprecated": false } }, "/api/valor/checkepi": { "post": { "summary": "Check EPI", "description": "", "operationId": "check-epi", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930907" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"code\": \"200\",\n \"Mp_id\": 15729,\n \"newUserId\": 34084,\n \"StoreID\": 18704,\n \"epi\": \"2319915501\",\n \"SerialNo\": null,\n \"processor_params\": \"{\\\"mid\\\":\\\"885890033738\\\",\\\"mid1\\\":\\\"\\\",\\\"vNumber\\\":\\\"77493046\\\",\\\"vNumber1\\\":\\\"\\\",\\\"storeNo\\\":\\\"7620\\\",\\\"storeNo1\\\":\\\"\\\",\\\"termNo\\\":\\\"3896\\\",\\\"termNo1\\\":\\\"\\\",\\\"association\\\":\\\"\\\",\\\"association1\\\":\\\"\\\",\\\"chain\\\":\\\"000000\\\",\\\"chain1\\\":\\\"\\\",\\\"agent\\\":\\\"7620\\\",\\\"agent1\\\":\\\"\\\",\\\"EBTcash\\\":0,\\\"EBTfood\\\":0,\\\"EbtNo\\\":\\\"\\\",\\\"EBTcash1\\\":0,\\\"EBTfood1\\\":0,\\\"EbtNo1\\\":\\\"\\\",\\\"binnumber\\\":\\\"404068\\\",\\\"binnumber1\\\":\\\"\\\",\\\"agentBank\\\":\\\"111111\\\",\\\"agentBank1\\\":\\\"\\\",\\\"industry\\\":\\\"Food/Restaurant\\\",\\\"industry1\\\":\\\"\\\",\\\"surchargeIndicator\\\":0,\\\"surchargePercentage\\\":0,\\\"label\\\":\\\"Seans Coffee & Dining\\\"}\",\n \"optStatus\": 0,\n \"statusEpi\": 0,\n \"createdDate\": \"2023-09-05\",\n \"createdBy\": 32702,\n \"isDeleted\": 1,\n \"deletedOn\": \"2023-09-06 16:21:52\",\n \"deletedBy\": \" \"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "string", "example": "200" }, "Mp_id": { "type": "integer", "example": 15729, "default": 0 }, "newUserId": { "type": "integer", "example": 34084, "default": 0 }, "StoreID": { "type": "integer", "example": 18704, "default": 0 }, "epi": { "type": "string", "example": "2319915501" }, "SerialNo": { }, "processor_params": { "type": "string", "example": "{\"mid\":\"885890033738\",\"mid1\":\"\",\"vNumber\":\"77493046\",\"vNumber1\":\"\",\"storeNo\":\"7620\",\"storeNo1\":\"\",\"termNo\":\"3896\",\"termNo1\":\"\",\"association\":\"\",\"association1\":\"\",\"chain\":\"000000\",\"chain1\":\"\",\"agent\":\"7620\",\"agent1\":\"\",\"EBTcash\":0,\"EBTfood\":0,\"EbtNo\":\"\",\"EBTcash1\":0,\"EBTfood1\":0,\"EbtNo1\":\"\",\"binnumber\":\"404068\",\"binnumber1\":\"\",\"agentBank\":\"111111\",\"agentBank1\":\"\",\"industry\":\"Food/Restaurant\",\"industry1\":\"\",\"surchargeIndicator\":0,\"surchargePercentage\":0,\"label\":\"Seans Coffee & Dining\"}" }, "optStatus": { "type": "integer", "example": 0, "default": 0 }, "statusEpi": { "type": "integer", "example": 0, "default": 0 }, "createdDate": { "type": "string", "example": "2023-09-05" }, "createdBy": { "type": "integer", "example": 32702, "default": 0 }, "isDeleted": { "type": "integer", "example": 1, "default": 0 }, "deletedOn": { "type": "string", "example": "2023-09-06 16:21:52" }, "deletedBy": { "type": "string", "example": " " } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": false,\n \"code\": \"200\",\n \"message\": \"epi Data Not Exits\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "string", "example": "200" }, "message": { "type": "string", "example": "epi Data Not Exits" } } } } } } }, "deprecated": false } }, "/api/valor/lastTxn": { "post": { "summary": "EPI Last Txn", "description": "", "operationId": "epi-last-txn", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930907" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/activateEpi": { "post": { "summary": "EPI Status", "description": "", "operationId": "activate-epi", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930907" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/statusUpdate": { "post": { "summary": "Merchant Status", "description": "", "operationId": "epi-status-update", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "merchantIds", "action" ], "properties": { "merchantIds": { "type": "integer", "description": "The merchantIds of the office login on which the merchant to be boarded", "default": 42923, "format": "int32" }, "action": { "type": "string", "description": "Activate and de-activate the EPI", "default": "activate" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/checkEPILength": { "post": { "summary": "EPI Detail", "description": "", "operationId": "epi-length-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "merchantId" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930907" }, "merchantId": { "type": "string", "description": "The merchantIds of the office login on which the merchant to be boarded", "default": "42923" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"code\": \"200\",\n \"Mp_id\": 28193,\n \"StoreID\": 32116,\n \"epi\": \"2319922983\",\n \"SerialNo\": null,\n \"processor_params\": \"{\\\"mid\\\":\\\"887000003193\\\",\\\"mid1\\\":\\\"\\\",\\\"vNumber\\\":\\\"75021674\\\",\\\"vNumber1\\\":\\\"\\\",\\\"storeNo\\\":\\\"5999\\\",\\\"storeNo1\\\":\\\"\\\",\\\"termNo\\\":\\\"1515\\\",\\\"termNo1\\\":\\\"\\\",\\\"association\\\":\\\"949006\\\",\\\"association1\\\":\\\"\\\",\\\"chain\\\":\\\"111111\\\",\\\"chain1\\\":\\\"\\\",\\\"agent\\\":\\\"0001\\\",\\\"agent1\\\":\\\"\\\",\\\"EbtNo\\\":\\\"\\\",\\\"EbtNo1\\\":\\\"\\\",\\\"binnumber\\\":\\\"999991\\\",\\\"binnumber1\\\":\\\"\\\",\\\"agentBank\\\":\\\"000000\\\",\\\"agentBank1\\\":\\\"\\\",\\\"industry\\\":\\\"Retail\\\",\\\"industry1\\\":\\\"\\\",\\\"EBTcash\\\":0,\\\"EBTcash1\\\":0,\\\"EBTfood\\\":0,\\\"EBTfood1\\\":0,\\\"surchargeIndicator\\\":0,\\\"surchargePercentage\\\":\\\"4.00\\\",\\\"label\\\":\\\"MERCHANT PORTAL LOGIN\\\",\\\"programType\\\":\\\"surcharge\\\"}\",\n \"message\": \"epi Data Exits\",\n \"StatusUser\": 1\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "string", "example": "200" }, "Mp_id": { "type": "integer", "example": 28193, "default": 0 }, "StoreID": { "type": "integer", "example": 32116, "default": 0 }, "epi": { "type": "string", "example": "2319922983" }, "SerialNo": { }, "processor_params": { "type": "string", "example": "{\"mid\":\"887000003193\",\"mid1\":\"\",\"vNumber\":\"75021674\",\"vNumber1\":\"\",\"storeNo\":\"5999\",\"storeNo1\":\"\",\"termNo\":\"1515\",\"termNo1\":\"\",\"association\":\"949006\",\"association1\":\"\",\"chain\":\"111111\",\"chain1\":\"\",\"agent\":\"0001\",\"agent1\":\"\",\"EbtNo\":\"\",\"EbtNo1\":\"\",\"binnumber\":\"999991\",\"binnumber1\":\"\",\"agentBank\":\"000000\",\"agentBank1\":\"\",\"industry\":\"Retail\",\"industry1\":\"\",\"EBTcash\":0,\"EBTcash1\":0,\"EBTfood\":0,\"EBTfood1\":0,\"surchargeIndicator\":0,\"surchargePercentage\":\"4.00\",\"label\":\"MERCHANT PORTAL LOGIN\",\"programType\":\"surcharge\"}" }, "message": { "type": "string", "example": "epi Data Exits" }, "StatusUser": { "type": "integer", "example": 1, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Enter Valid EPI\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Enter Valid EPI" }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/getViewEpi": { "post": { "summary": "EPI View check", "description": "", "operationId": "epi-view-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319930907" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Success\",\n \"data\": [\n {\n \"ApplicationType\": \"DEFAULT\"\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Success" }, "data": { "type": "array", "items": { "type": "object", "properties": { "ApplicationType": { "type": "string", "example": "DEFAULT" } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Enter Valid EPI\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Enter Valid EPI" }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/getMerchantList": { "post": { "summary": "Merchant List", "description": "", "operationId": "merchant-get", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "user_id", "limit", "offset" ], "properties": { "user_id": { "type": "string", "default": "9579" }, "limit": { "type": "string", "description": "Limit for pagination. Max 50 and default as 0", "default": "5" }, "offset": { "type": "string", "description": "Offset for pagination. Default as 0", "default": "0" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/getMerchantCredential": { "post": { "summary": "Fetch APP ID & APP Keys", "description": "", "operationId": "merchant-get-credential", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userID" ], "properties": { "userID": { "type": "string", "description": "Merchant User ID (Max length of 11 chars)", "default": "9581" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/getEpiAppKeyDetails": { "post": { "summary": "EPI - Generate API Keys", "description": "", "operationId": "api-keys-get", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiYzg2Y2NjNTItYmNlNy00N2IwLWI2NGQtOGRkMTliYTEzNDIzIiwiaWF0IjoxNzMyMDg2ODExLCJleHAiOjE3MzIxMTU2MTF9.26qD4C18oQLWstNvKhdu7t5yTVqTUMnp7m_0aAGk6oA" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2104766894" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getIsoList": { "post": { "summary": "ISO Get", "description": "", "operationId": "iso-get", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getEpi": { "post": { "summary": "Get EPI", "description": "", "operationId": "get-epi-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" }, "serialNo": { "type": "string", "default": "118214503188" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getDeviceVolume": { "post": { "summary": "Get Device Volume", "description": "", "operationId": "get-device-volume", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "month", "token" ], "properties": { "userId": { "type": "string", "default": "9579" }, "month": { "type": "string" }, "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getIsoInfo": { "post": { "summary": "Get ISO Info", "description": "", "operationId": "get-iso-info", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "token" ], "properties": { "userId": { "type": "string", "default": "9579" }, "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getISOVolume": { "post": { "summary": "Get ISO Volume", "description": "", "operationId": "get-iso-volume", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "userId", "month" ], "properties": { "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" }, "userId": { "type": "string", "default": "9579" }, "month": { "type": "string", "default": "2023-09-12" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getSimDetails": { "post": { "summary": "Get SIM Details", "description": "", "operationId": "get-sim-details", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "userId", "month" ], "properties": { "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" }, "userId": { "type": "string", "default": "9579" }, "month": { "type": "string", "default": "12-09-2023" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valorCRM/getSerialNo": { "post": { "summary": "Get Serial No", "description": "", "operationId": "get-serial-no", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "epi" ], "properties": { "token": { "type": "string", "default": "f198d54f3ea07ae7679bbebf60142b0b" }, "epi": { "type": "string", "default": "2303184606" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/deviceParameter?hardware": { "post": { "summary": "Device Parameter For Hardware Device", "description": "", "operationId": "hardware-device-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "data" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319924327" }, "data": { "type": "object", "properties": { "tip_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_on_receipt": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "smart_tip": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_options_type": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003ETip Option Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPercentage\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDollar\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVariable\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 3, "format": "int32" }, "tip_custom_type": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003ETip Custom Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPercentage\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDollar\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 2, "format": "int32" }, "tip_custom_range": { "type": "integer", "description": "The Input must fall within the range of 0 to 99999.", "default": 1, "format": "int32" }, "tip_options": { "type": "array", "description": "The Input must fall within the range of '1' to '350' and must contain exactly eight unique numeric values, split into two sets of four.", "default": [1, 2, 3, 4, 1, 2, 3, 4], "items": { "type": "integer", "format": "int32" } }, "show_totals_per_tip_suggestion": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "max_tip_percentage": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "max_tip_dollar": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "receipt_for_tip_adjust": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EReceipt For Tip Adjust\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPrompt and Print\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAuto Print\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDon't Print\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "fixed_tip_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "show_tip_suggestion": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EShow Tip Sugestion\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETip On Screen Only\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EBoth On Screen and On Receipt\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETip On Receipt Only\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ENone\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "fixed_tip_in_percentage": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "fixed_tip_value": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "tax_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "include_tax_for_cash": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "show_remove_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "prompt_password_to_remove_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "state_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "city_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "reduced_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "enable_for_all_debit_card": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "signature_debit_only": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "customer_fee_disclosure": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "include_tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "apply_fee_with_tip": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "include_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "apply_fee_with_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "include_cash": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_discount_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_discount_label": { "type": "string", "description": "The Input should consist of 1 to 17 characters at most.", "default": "Cash Discount" }, "show_discount_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "show_discount_label": { "type": "string", "description": "The Input should consist of 1 to 17 characters at most.", "default": "Show Discount" }, "show_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "prompt_password_to_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "settlement_report_detailed": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "settlement_report_summary": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "email_settlement_report": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "hide_receipt_option": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "sms_receipt": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "paper_receipt": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "settlement_report_tip": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "settlement_report_for_no_transaction_batches": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "print_fee_base_amount_detail": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "force_on_screen_signature": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "force_signature_prompt": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EForced Signature Prompt\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDefault\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EOn Paper\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EOn Display\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ENone\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "receipt_option_customer": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EReceipt Option Customer\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDon't Print\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAuto\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPrompt\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "receipt_option_merchant": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EReceipt Option Merchant\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDon't Print\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAuto\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPrompt\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "receipt_for_declined_transaction": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "avs": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ENone\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip Only\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAddress Only\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip & Address\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "avs_action_on_failed": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS Action on Failed\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDecline\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EApprove and Notify\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "disable_pin_debit": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_back_on_debit_cards_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_back_on_debit_cards_amount": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 100, "format": "int32" }, "qsr_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "qsr_amount": { "type": "number", "description": "The Input must fall within the range of 1.00 to 250.00.", "default": 1, "format": "float" }, "pos_integration_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "amount_confirmation": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "hide_ip": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "connection_type": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EConnection Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ETCP\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EWebSocket\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "pos_name": { "type": "string", "description": "The Input should consist of 1 to 50 characters at most.", "default": "POS Name" }, "valor_connect_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_valor_connect_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_valor_connect": { "type": "integer", "description": "The password must consist of a minimum of 4 numeric digits.", "default": 1000, "format": "int32" }, "valor_connect_timer_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "valor_connect_timer": { "type": "integer", "description": "The Input must fall within the range of 120 to 999.", "default": 120, "format": "int32" }, "pre_sale_qr_allowed": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "enable_l2": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "split_payment": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "pin_bypass_allowed": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_void": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "password_for_refund_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_refund_amount": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 100, "format": "int32" }, "password_for_preauth": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "disable_all_password": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "card_present_prompt_for_manual": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "partial_approval": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "application_options": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EApplication Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDefault\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDual Pricing\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EBin Base Surcharge\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Manual Tax\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Exclusive Tax\u003C/td\u003E \u003Ctd\u003E5\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Inclusive Tax\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "amount_confirmation_screen_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "amount_confirmation_before_present_card": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "validate_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "assigned_keygroup": { "type": "string", "description": "The \"assigned_keygroup\" parameter is only applicable in the production environment. Enter Key Group Name" }, "force_acknowledge": { "type": "boolean", "description": "The \"force_acknowledge\" parameter is only applicable in the production environment. Excepted either true or false." }, "delete_keys": { "type": "boolean", "description": "The \"delete_keys\" parameter is only applicable in the production environment. Excepted either true or false." }, "header_two": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most.", "default": "header_two" }, "header_three": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_three" }, "header_four": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_four" }, "header_five": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_five" }, "header_six": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_six" }, "header_seven": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_seven" }, "footer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_one" }, "footer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_two" }, "footer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_three" }, "footer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_four" }, "footer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_five" }, "footer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_six" }, "footer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_seven" }, "footer_eight": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_eight" }, "footer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_nine" }, "footer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_ten" }, "enable_disclaimer": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "disclaimer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_one" }, "disclaimer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_two" }, "disclaimer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_three" }, "disclaimer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_four" }, "disclaimer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_five" }, "disclaimer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_six" }, "disclaimer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_seven" }, "disclaimer_eigth": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_eigth" }, "disclaimer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_nine" }, "disclaimer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_ten" }, "standby_timer": { "type": "integer", "description": "The Input must fall within the range of '30' to '600000'.", "format": "int32" }, "sleep_timer": { "type": "integer", "description": "The Input must fall within the range of '30' to '600000'.", "format": "int32" }, "display_logo_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "display_logo": { "type": "integer", "description": "The Input must fall within the range of 1 to 10.", "format": "int32" }, "auto_shutdown_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "auto_shutdown_timer": { "type": "integer", "description": "The Input must fall within the range of '1' to '9999'.", "format": "int32" }, "auto_heartbeat_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "auto_heartbeat_timer": { "type": "string", "description": "The Input must be in 30-min intervals, from '00:00 AM' to '11:30 PM'." }, "batch_out_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "batch_out_timer": { "type": "string", "description": "The Input must be in 15-min intervals, from '00:00 AM' to '11:45 PM'." }, "show_device_lable": { "type": "boolean", "description": "Excepted either true or false." }, "show_menu_option": { "type": "boolean", "description": "Excepted either true or false." }, "view_tranactions_menu": { "type": "boolean", "description": "Excepted either true or false." }, "batchout_menu": { "type": "boolean", "description": "Excepted either true or false." }, "reprint_receipt_menu": { "type": "boolean", "description": "Excepted either true or false." }, "tip_adjust_menu": { "type": "boolean", "description": "Excepted either true or false." }, "pre_sale_menu": { "type": "boolean", "description": "Excepted either true or false." }, "helpme_icon_menu": { "type": "boolean", "description": "Excepted either true or false." }, "reports_menu": { "type": "boolean", "description": "Excepted either true or false." }, "clear_reversal_menu": { "type": "boolean", "description": "Excepted either true or false." }, "view_main_menu": { "type": "boolean", "description": "Excepted either true or false." }, "run_standalone_menu": { "type": "boolean", "description": "Excepted either true or false." }, "wifi_config_menu": { "type": "boolean", "description": "Excepted either true or false." }, "sim_config_menu": { "type": "boolean", "description": "Excepted either true or false." }, "reboot_terminal_menu": { "type": "boolean", "description": "Excepted either true or false." }, "run_download_menu": { "type": "boolean", "description": "Excepted either true or false." }, "settings_menu": { "type": "boolean", "description": "Excepted either true or false." }, "access_default_screen": { "type": "boolean", "description": "Excepted either true or false." }, "display_ip_address": { "type": "boolean", "description": "Excepted either true or false." }, "invoice_required": { "type": "boolean", "description": "Excepted either true or false." }, "enhanced_retry_logic": { "type": "boolean", "description": "Excepted either true or false." }, "isv_name": { "type": "string" }, "password_for_ebt": { "type": "boolean", "description": "Excepted either true or false." }, "duplicate_transaction_check": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "server_clerk_setup": { "type": "boolean", "description": "Excepted either true or false." }, "clerk_mandate": { "type": "boolean", "description": "Excepted either true or false." }, "add_clerk_details": { "type": "object", "properties": { "label": { "type": "string", "description": "The Input should consist of 1 to 10 characters at most." }, "options": { "type": "array", "items": { "properties": { "serverid": { "type": "string", "description": "The Input must fall within the range of 1 to 999." }, "servername": { "type": "string", "description": "The Input should consist of 1 to 14 characters at most." } }, "type": "object" } } } }, "show_no_tip_button": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_label": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most." }, "visa_ten_dollar": { "type": "boolean", "description": "Excepted either true or false." }, "card_type": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "enable_pinpad": { "type": "boolean", "description": "Excepted either true or false." }, "display_confirm_screen_pinpad": { "type": "boolean", "description": "Excepted either true or false." }, "show_remove_card": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry_credit": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry_debit": { "type": "boolean", "description": "Excepted either true or false." }, "bypass_cvv_entry": { "type": "boolean", "description": "Excepted either true or false." }, "offline_transaction": { "type": "boolean", "description": "Excepted either true or false." }, "offline_max_dollar_per_txn": { "type": "number", "description": "The Input must fall within the range of '0.01' to '500.00'.", "format": "float" }, "offline_max_dollar_total_txn": { "type": "number", "description": "The Input must fall within the range of '0.01' to '5000.00'.", "format": "float" }, "offline_max_no_of_txn": { "type": "integer", "description": "The Input must fall within the range of 1 to 60.", "format": "int32" }, "offline_max_no_of_txn_per_card": { "type": "integer", "description": "The Input must fall within the range of 1 to 5.", "format": "int32" }, "offline_delete_transaction": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "offline_upload_mode": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "change_management_cash_transaction": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_indicator": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_indicator_mode": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "surcharge_range_from": { "type": "number", "description": "The Input must fall within the range of '0.01' to '9999.99'.", "format": "float" }, "surcharge_range_end": { "type": "number", "description": "The Input must fall within the range of '0.01' to '9999.99'.", "format": "float" }, "food_amount": { "type": "boolean", "description": "Excepted either true or false." }, "present_device_customer": { "type": "boolean", "description": "Excepted either true or false." }, "remove_sub_total": { "type": "boolean", "description": "Excepted either true or false." }, "entered_amount": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "show_card_cash_presale": { "type": "boolean", "description": "Excepted either true or false." }, "password_for_cash": { "type": "boolean", "description": "Excepted either true or false." }, "show_pricing_on_receipt": { "type": "boolean", "description": "Excepted either true or false." }, "show_savings": { "type": "boolean", "description": "Excepted either true or false." }, "saving_label_card": { "type": "string", "description": "The Input should consist of 1 to 31 characters at most." }, "saving_label_cash": { "type": "string", "description": "The Input should consist of 1 to 31 characters at most." }, "show_card_cash_pricing": { "type": "boolean", "description": "Excepted either true or false." }, "card_label_on_terminal": { "type": "string", "description": "The Input should consist of 1 to 8 characters at most." }, "customer_satisfaction_survey": { "type": "boolean", "description": "Excepted either true or false." }, "additional_input_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "additional_input": { "type": "array", "items": { "properties": { "display_text": { "type": "string", "description": "The input should be a string of 1 to 16 alphanumeric characters without special characters." }, "text_format": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "min_length": { "type": "boolean", "description": "The Input must fall within the range of 0 to 15." }, "max_length": { "type": "integer", "description": "The Input must fall within the range of 1 to 16.", "format": "int32" }, "mandatory": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "duplicate_check": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" } }, "type": "object" } }, "contact_us": { "type": "boolean", "description": "Excepted either true or false." }, "call_me_ticket_option": { "type": "boolean", "description": "Excepted either true or false." }, "reset_manage_password": { "type": "boolean", "description": "Excepted either true or false." }, "ebt_cashback_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "ebt_cashback_amount": { "type": "integer", "description": "The Input must fall within the range of '1' to '9999'.", "format": "int32" }, "merchant_receipt_sms_option": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "no_receipt": { "type": "boolean", "description": "Excepted either true or false." }, "email_receipt": { "type": "boolean", "description": "Excepted either true or false." }, "access_valor_store": { "type": "boolean", "description": "Excepted either true or false." }, "display_customer_facing_screen": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "display_image_scale": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" } } }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": true\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"The 'tip_on_receipt' depends on the 'tip_enabled'.\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "The 'tip_on_receipt' depends on the 'tip_enabled'." }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/deviceParameter?vt": { "post": { "summary": "Device Parameter For Virtual Terminal Device", "description": "", "operationId": "virtual-terminal-device-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "data" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2412333540" }, "data": { "type": "object", "properties": { "tip_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_options": { "type": "array", "description": "The Input must fall within the range of 1 to 350 and must contain exactly four unique numeric values.", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } }, "max_tip_percentage": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "tax_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "state_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "city_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "reduced_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "enable_for_all_debit_card": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "customer_fee_disclosure": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "include_tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "apply_fee_with_tip": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "include_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "apply_fee_with_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "show_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "prompt_password_to_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "email_settlement_report": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "avs": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ENone\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip Only\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAddress Only\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip & Address\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "avs_action_on_failed": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS Action on Failed\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDecline\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EApprove and Notify\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "password_for_refund_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_refund_amount": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 100, "format": "int32" }, "partial_approval": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "descriptor_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "descriptor_label": { "type": "string", "description": "The Input should consist of 1 to 21 characters at most.", "default": "Descriptor" }, "application_options": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EApplication Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDefault\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDual Pricing\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EBin Base Surcharge\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Manual Tax\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Exclusive Tax\u003C/td\u003E \u003Ctd\u003E5\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Inclusive Tax\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "validate_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "header_two": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most.", "default": "header_two" }, "header_three": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_three" }, "header_four": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_four" }, "header_five": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_five" }, "header_six": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_six" }, "header_seven": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_seven" }, "footer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_one" }, "footer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_two" }, "footer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_three" }, "footer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_four" }, "footer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_five" }, "footer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_six" }, "footer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_seven" }, "footer_eight": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_eight" }, "footer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_nine" }, "footer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_ten" }, "enable_disclaimer": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "disclaimer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_one" }, "disclaimer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_two" }, "disclaimer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_three" }, "disclaimer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_four" }, "disclaimer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_five" }, "disclaimer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_six" }, "disclaimer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_seven" }, "disclaimer_eigth": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_eigth" }, "disclaimer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_nine" }, "disclaimer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_ten" }, "batch_out_timer": { "type": "string", "description": "The Input must be in 15-min intervals, from '00:00 AM' to '11:45 PM'." }, "show_device_lable": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_label": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most." }, "visa_ten_dollar": { "type": "boolean", "description": "Excepted either true or false." }, "card_type": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "bypass_cvv_entry": { "type": "boolean", "description": "Excepted either true or false." }, "disable_merchant_copy_sms": { "type": "boolean", "description": "Excepted either true or false." }, "disable_customer_copy_sms": { "type": "boolean", "description": "Excepted either true or false." }, "disable_merchant_copy_email": { "type": "boolean", "description": "Excepted either true or false." }, "disable_customer_copy_email": { "type": "boolean", "description": "Excepted either true or false." }, "invoice_number_required": { "type": "boolean", "description": "Excepted either true or false." }, "image_capture_option_txn": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "email_required": { "type": "boolean", "description": "Excepted either true or false." }, "phone_required": { "type": "boolean", "description": "Excepted either true or false." }, "food_amount": { "type": "boolean", "description": "Excepted either true or false." }, "image_capture_sale": { "type": "boolean", "description": "Excepted either true or false." }, "image_capture_einvoice": { "type": "boolean", "description": "Excepted either true or false." }, "allow_skip_with_reason": { "type": "boolean", "description": "Excepted either true or false." }, "disclaimer_vt_credit": { "type": "boolean", "description": "Excepted either true or false." }, "disclaimer_vt_debit": { "type": "boolean", "description": "Excepted either true or false." }, "disclaimer_credit_einvoice": { "type": "boolean", "description": "Excepted either true or false." }, "disclaimer_debit_einvoice": { "type": "boolean", "description": "Excepted either true or false." }, "disclaimer_credit_label": { "type": "string", "description": "The Input should consist of 1 to 200 characters at most." }, "disclaimer_debit_label": { "type": "string", "description": "The Input should consist of 1 to 200 characters at most." }, "customer_satisfaction_survey": { "type": "boolean", "description": "Excepted either true or false." }, "company_name_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "company_name_text": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most." }, "company_name_option": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "additional_input_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "additional_input": { "type": "array", "items": { "properties": { "display_text": { "type": "string", "description": "The input should be a string of 1 to 16 alphanumeric characters without special characters." }, "text_format": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "min_length": { "type": "boolean", "description": "The Input must fall within the range of 0 to 15." }, "max_length": { "type": "integer", "description": "The Input must fall within the range of 1 to 16.", "format": "int32" }, "mandatory": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "duplicate_check": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" } }, "type": "object" } } } }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": true\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"The 'tip_on_receipt' depends on the 'tip_enabled'.\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "The 'tip_on_receipt' depends on the 'tip_enabled'." }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/deviceParameter?rckt": { "post": { "summary": "Device Parameter For RCKT Device", "description": "", "operationId": "rckt-device-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "data" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319924328" }, "data": { "type": "object", "properties": { "tip_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "tip_options_type": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003ETip Option Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPercentage\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDollar\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVariable\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 3, "format": "int32" }, "tip_custom_type": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003ETip Custom Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EPercentage\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDollar\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 2, "format": "int32" }, "tip_custom_range": { "type": "integer", "description": "The Input must fall within the range of 0 to 99999.", "default": 1, "format": "int32" }, "tip_options": { "type": "array", "description": "The Input must fall within the range of '1' to '350' and must contain exactly eight unique numeric values, split into two sets of four.", "default": [1, 2, 3, 4, 1, 2, 3, 4], "items": { "type": "integer", "format": "int32" } }, "max_tip_percentage": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "max_tip_dollar": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "fixed_tip_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "fixed_tip_in_percentage": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "fixed_tip_value": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 350, "format": "int32" }, "tax_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "include_tax_for_cash": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "state_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "city_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "reduced_tax": { "type": "number", "description": "The Input must fall within the range of 0.001 to 15.000.", "default": 3, "format": "float" }, "enable_for_all_debit_card": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "signature_debit_only": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "customer_fee_disclosure": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "include_tip_on_screen": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "apply_fee_with_tip": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "include_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "apply_fee_with_tax": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "include_cash": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_discount_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_discount_label": { "type": "string", "description": "The Input should consist of 1 to 17 characters at most.", "default": "cash discount" }, "show_discount_enabled": { "type": "boolean", "description": "The Input should consist of 1 to 17 characters at most.", "default": true }, "show_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "prompt_password_to_remove_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "email_settlement_report": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "hide_receipt_option": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "sms_receipt": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "email_receipt": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "force_on_screen_signature": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "forced_signature_prompt": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "avs": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ENone\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip Only\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EAddress Only\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EZip & Address\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "avs_action_on_failed": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EAVS Action on Failed\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDecline\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EApprove and Notify\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "disable_pin_debit": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_back_on_debit_cards_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "cash_back_on_debit_cards_amount": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 100, "format": "int32" }, "qsr_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "qsr_amount": { "type": "number", "description": "The Input must fall within the range of 1.00 to 250.00.", "default": 1, "format": "float" }, "pre_sale_qr_allowed": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "password_for_void": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "password_for_refund_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "password_for_refund_amount": { "type": "integer", "description": "The Input must fall within the range of 1 to 9999.", "default": 100, "format": "int32" }, "password_for_preauth": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "partial_approval": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "application_options": { "type": "integer", "description": "\u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EApplication Type\u003C/th\u003E \u003Cth\u003EOptions\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDefault\u003C/td\u003E \u003Ctd\u003E1\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EDual Pricing\u003C/td\u003E \u003Ctd\u003E2\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EBin Base Surcharge\u003C/td\u003E \u003Ctd\u003E3\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Manual Tax\u003C/td\u003E \u003Ctd\u003E4\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Exclusive Tax\u003C/td\u003E \u003Ctd\u003E5\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EFalcon Inclusive Tax\u003C/td\u003E \u003Ctd\u003E6\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": 1, "format": "int32" }, "amount_confirmation_screen_enabled": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "amount_confirmation_before_present_card": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "validate_fee": { "type": "boolean", "description": "Excepted either true or false.", "default": false }, "assigned_keygroup": { "type": "string", "description": "The \"assigned_keygroup\" parameter is only applicable in the production environment. Enter Key Group Name" }, "force_acknowledge": { "type": "boolean", "description": "The \"force_acknowledge\" parameter is only applicable in the production environment. Excepted either true or false." }, "header_two": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most.", "default": "header_two" }, "header_three": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_three" }, "header_four": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_four" }, "header_five": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_five" }, "header_six": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_six" }, "header_seven": { "type": "string", "description": "The Input should consist of 1 to 25 characters at most.", "default": "header_seven" }, "footer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_one" }, "footer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_two" }, "footer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_three" }, "footer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_four" }, "footer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_five" }, "footer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_six" }, "footer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_seven" }, "footer_eight": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_eight" }, "footer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_nine" }, "footer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "footer_ten" }, "enable_disclaimer": { "type": "boolean", "description": "Excepted either true or false.", "default": true }, "disclaimer_one": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_one" }, "disclaimer_two": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_two" }, "disclaimer_three": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_three" }, "disclaimer_four": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_four" }, "disclaimer_five": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_five" }, "disclaimer_six": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_six" }, "disclaimer_seven": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_seven" }, "disclaimer_eigth": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_eigth" }, "disclaimer_nine": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_nine" }, "disclaimer_ten": { "type": "string", "description": "The Input should consist of 1 to 24 characters at most.", "default": "disclaimer_ten" }, "sleep_timer": { "type": "integer", "description": "The Input must fall within the range of '30' to '600000'.", "format": "int32" }, "batch_out_timer": { "type": "string", "description": "The Input must be in 15-min intervals, from '00:00 AM' to '11:45 PM'." }, "show_device_lable": { "type": "boolean", "description": "Excepted either true or false." }, "password_for_ebt": { "type": "boolean", "description": "Excepted either true or false." }, "server_clerk_setup": { "type": "boolean", "description": "Excepted either true or false." }, "clerk_mandate": { "type": "boolean", "description": "Excepted either true or false." }, "add_clerk_details": { "type": "object", "properties": { "label": { "type": "string", "description": "The Input should consist of 1 to 10 characters at most." }, "options": { "type": "array", "items": { "properties": { "serverid": { "type": "string", "description": "The Input must fall within the range of 1 to 999." }, "servername": { "type": "string", "description": "The Input should consist of 1 to 14 characters at most." } }, "type": "object" } } } }, "surcharge_label": { "type": "string", "description": "The Input should consist of 1 to 26 characters at most." }, "card_type": { "type": "integer", "description": "Expected values are 1, 2 or 3.", "format": "int32" }, "visa_ten_dollar": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry_credit": { "type": "boolean", "description": "Excepted either true or false." }, "manual_entry_debit": { "type": "boolean", "description": "Excepted either true or false." }, "bypass_cvv_entry": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_indicator": { "type": "boolean", "description": "Excepted either true or false." }, "surcharge_indicator_mode": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "surcharge_range_from": { "type": "number", "description": "The Input must fall within the range of '0.01' to '9999.99'.", "format": "float" }, "surcharge_range_end": { "type": "number", "description": "The Input must fall within the range of '0.01' to '9999.99'.", "format": "float" }, "food_amount": { "type": "boolean", "description": "Excepted either true or false." }, "remove_sub_total": { "type": "boolean", "description": "Excepted either true or false." }, "show_card_cash_presale": { "type": "boolean", "description": "Excepted either true or false." }, "password_for_cash": { "type": "boolean", "description": "Excepted either true or false." }, "show_pricing_on_receipt": { "type": "boolean", "description": "Excepted either true or false." }, "show_savings": { "type": "boolean", "description": "Excepted either true or false." }, "saving_label_card": { "type": "string", "description": "The Input should consist of 1 to 31 characters at most." }, "saving_label_cash": { "type": "string", "description": "The Input should consist of 1 to 31 characters at most." }, "show_card_cash_pricing": { "type": "boolean", "description": "Excepted either true or false." }, "card_label_on_terminal": { "type": "string", "description": "The Input should consist of 1 to 8 characters at most." }, "customer_satisfaction_survey": { "type": "boolean", "description": "Excepted either true or false." }, "additional_input_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "additional_input": { "type": "array", "items": { "properties": { "display_text": { "type": "string", "description": "The input should be a string of 1 to 16 alphanumeric characters without special characters." }, "text_format": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "min_length": { "type": "boolean", "description": "The Input must fall within the range of 0 to 15." }, "max_length": { "type": "integer", "description": "The Input must fall within the range of 1 to 16.", "format": "int32" }, "mandatory": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" }, "duplicate_check": { "type": "integer", "description": "Expected values are 1 or 2.", "format": "int32" } }, "type": "object" } }, "ebt_cashback_enabled": { "type": "boolean", "description": "Excepted either true or false." }, "ebt_cashback_amount": { "type": "integer", "description": "The Input must fall within the range of '1' to '9999'.", "format": "int32" }, "no_receipt": { "type": "boolean", "description": "Excepted either true or false." } } }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": true\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "boolean", "example": true, "default": true } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"The 'tip_on_receipt' depends on the 'tip_enabled'.\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "The 'tip_on_receipt' depends on the 'tip_enabled'." }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/login?token": { "post": { "summary": "Merchant - Create Bearer Token", "description": "", "operationId": "merchant-create-bearer-token-copy-1", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "mailId", "SubmailId", "passCode" ], "properties": { "mailId": { "type": "string", "description": "E-mail id of the iso office - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "demovaloriso" }, "SubmailId": { "type": "string", "description": "Submail / the username of the sub office - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "demovaloriso" }, "passCode": { "type": "string", "description": "The password of the office login on which the merchant to be boarded", "default": "Valor@123" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Success\",\n \"status\": true,\n \"code\": 200,\n \"data\": {\n \"user_id\": 39623,\n \"userType_id\": 2,\n \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc\"\n }\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Success" }, "status": { "type": "boolean", "example": true, "default": true }, "code": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "user_id": { "type": "integer", "example": 39623, "default": 0 }, "userType_id": { "type": "integer", "example": 2, "default": 0 }, "access_token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMDg1YWZkY2UtNGVmZi00YTEyLTgxMzctMmE0OGE5ZTdmMTQwIiwiaWF0IjoxNzAyMTA5MTA1LCJleHAiOjE3MDIxMzc5MDV9.V_wZv-oSo6ajFXLBLM87Ugpdcjt_fFJ4Msqu2STdgYc" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"message\": \"Invalid password\",\n \"status\": false,\n \"code\": 400\n}" } }, "schema": { "type": "object", "properties": { "message": { "type": "string", "example": "Invalid password" }, "status": { "type": "boolean", "example": false, "default": true }, "code": { "type": "integer", "example": 400, "default": 0 } } } } } } }, "deprecated": false } }, "/api/valor/getEpiAppKeyDetails?apikey": { "post": { "summary": "Generating API Keys - via API", "description": "", "operationId": "generating-api-keys-via-api", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token-copy-1\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2412333540" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/iso-billing-statement": { "post": { "summary": "ISO Billing Statement", "description": "", "operationId": "iso-billing-statement", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjozOTYyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiMjNjMDVhZDgtYmJlYy00NzZiLTgwZWYtYzI4N2RjOTBjZjFhIiwiaWF0IjoxNzAyNDU5ODk5LCJleHAiOjE3MDI0ODg2OTl9.dGEejm19zmiX8eHsF4CseTH2glHa3MdXtYlsgjQM3Ew" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "month", "year", "limit", "offset" ], "properties": { "month": { "type": "string", "description": "Set the month of fetch the billing statement (Ex: MM)", "default": "09" }, "year": { "type": "string", "description": "Set the year of fetch the billing statement (Ex: YYYY)", "default": "2024" }, "limit": { "type": "integer", "description": "Max value set to 1000", "default": 25, "format": "int32" }, "offset": { "type": "integer", "description": "Offset for pagination. Default 0", "default": 0, "format": "int32" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/getepidetails?merchant": { "post": { "summary": "Merchant View", "description": "Merchant View", "operationId": "merchant-view-3", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZjA5Yjg4YTEtZTc0Ni00NTlkLWE0ZDYtODcyNjc3NWVlMTI3IiwiaWF0IjoxNzMzMjEyMzU5LCJleHAiOjE3MzMyNDExNTl9.pQDWAyyA1opea22QnUWMb1ih5f525apHv-KvHkThTx8" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "epi", "mp_id" ], "properties": { "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319931361" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43919" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/createStore": { "post": { "summary": "Store Add", "description": "", "operationId": "store-add-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZjA5Yjg4YTEtZTc0Ni00NTlkLWE0ZDYtODcyNjc3NWVlMTI3IiwiaWF0IjoxNzMzMjEyMzU5LCJleHAiOjE3MzMyNDExNTl9.pQDWAyyA1opea22QnUWMb1ih5f525apHv-KvHkThTx8" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "dbaName", "newUserId", "mp_id", "storeData", "selectedState", "s4f", "processor", "rollUp" ], "properties": { "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "ZEUS EXPRESS JOHNSTON" }, "newUserId": { "type": "string", "description": "Merchant User ID (Max length of 11 chars)", "default": "72239" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43919" }, "storeData": { "type": "array", "items": { "properties": { "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "EL TRI MX RESTA Add" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "4100 JOHNSTON ST" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "LAFAYETTE" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "LA" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "70503" }, "storeTimezone": { "type": "string", "description": "Store time zone (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "EL TRI MX RESTA" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "office@valorpaytech.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "3377040344" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "5812" }, "descriptors": { "type": "array", "description": "It should be 25 chars", "default": [], "items": { "type": "string" } }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft POS" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "1" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "batch_number": { "type": "string" }, "features": { "type": "object", "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } } }, "processorData": { "type": "array", "items": { "properties": { "mid": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "887000003193" }, "mid1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "\"\"", "format": "json" }, "vNumber": { "type": "string", "description": "vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "75021674" }, "vNumber1": { "type": "string", "description": "vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "storeNo": { "type": "string", "description": "Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "5999" }, "storeNo1": { "type": "string", "description": "Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "termNo": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "1515" }, "termNo1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "association": { "type": "string", "description": "Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "949006" }, "association1": { "type": "string", "description": "Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "chain": { "type": "string", "description": "Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "111111" }, "chain1": { "type": "string", "description": "Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agent": { "type": "string", "description": "Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "0001" }, "agent1": { "type": "string", "description": "Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber": { "type": "string", "description": "Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "999991" }, "binnumber1": { "type": "string", "description": "Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agentBank": { "type": "string", "description": "Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "000000" }, "agentBank1": { "type": "string", "description": "Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "industry": { "type": "string", "description": "The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "Retail" }, "industry1": { "type": "string", "description": "The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EBTcash": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "4.00" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "MERCHANT PORTAL LOGIN" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "mid", "mid1", "vNumber", "vNumber1", "storeNo", "storeNo1", "termNo", "association", "association1", "chain", "chain1", "agent", "agent1", "EbtNo", "EbtNo1", "binnumber", "binnumber1", "agentBank", "agentBank1", "industry", "industry1", "EBTcash", "EBTcash1", "EBTfood1", "surchargeIndicator", "surchargePercentage", "label", "programType" ], "type": "object" } }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NJ" } }, "required": [ "device", "deviceType", "processor", "epiLabel", "selectedState" ], "type": "object" } } }, "required": [ "storeName", "storeAddress", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "mccCode" ], "type": "object" } }, "selectedState": { "type": "string", "description": "Selected state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "LA" }, "s4f": { "type": "string", "description": "1 (sf4) or 2 (traditional)", "default": "1" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS : 1 and FD : 2)", "default": "1" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "2" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/createEPI": { "post": { "summary": "EPI Add", "description": "", "operationId": "epi-add-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZDliZGU1YWQtZTczNy00MzNiLWJkZDMtMWEwZTk4YjE3NzA0IiwiaWF0IjoxNzMzMjIzMjQ4LCJleHAiOjE3MzMyNTIwNDh9.h1husvYvaP62f9-R8I3hi2b9vyM9bXSmeYWq2E9gQyQ" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "newUserId", "mp_id", "storeData", "s4f", "rollUp", "processor" ], "properties": { "newUserId": { "type": "string", "description": "Merchant User ID (Max length of 11 chars)", "default": "72239" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43919" }, "storeData": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "The unique id refers to a particular store of the merchant", "default": "48779" }, "epiData": { "type": "array", "items": { "properties": { "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft POS" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "1" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "batch_number": { "type": "string" }, "features": { "type": "object", "properties": { "tip": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "array", "default": [5, 10, 15, 20], "items": { "type": "integer", "format": "int32" } } } }, "surcharge": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "4.00" } } }, "tax": { "type": "object", "required": [ "enabled", "value" ], "properties": { "enabled": { "type": "boolean", "default": false }, "value": { "type": "string", "default": "0" } } } } }, "processorData": { "type": "array", "items": { "properties": { "mid": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "887000003193" }, "mid1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "\"\"", "format": "json" }, "vNumber": { "type": "string", "description": "vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "75021674" }, "vNumber1": { "type": "string", "description": "vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "storeNo": { "type": "string", "description": "Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "5999" }, "storeNo1": { "type": "string", "description": "Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "termNo": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "1515" }, "termNo1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "association": { "type": "string", "description": "Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "949006" }, "association1": { "type": "string", "description": "Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "chain": { "type": "string", "description": "Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "111111" }, "chain1": { "type": "string", "description": "Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agent": { "type": "string", "description": "Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "0001" }, "agent1": { "type": "string", "description": "Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber": { "type": "string", "description": "Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "999991" }, "binnumber1": { "type": "string", "description": "Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agentBank": { "type": "string", "description": "Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "000000" }, "agentBank1": { "type": "string", "description": "Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "industry": { "type": "string", "description": "The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "Retail" }, "industry1": { "type": "string", "description": "The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EBTcash": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "4.00" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "MERCHANT PORTAL LOGIN" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "mid", "mid1", "vNumber", "vNumber1", "storeNo", "storeNo1", "termNo", "association", "association1", "chain", "chain1", "agent", "agent1", "EbtNo", "EbtNo1", "binnumber", "binnumber1", "agentBank", "agentBank1", "industry", "industry1", "EBTcash", "EBTcash1", "EBTfood1", "surchargeIndicator", "surchargePercentage", "label", "programType" ], "type": "object" } }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NJ" } }, "required": [ "device", "deviceType", "processor", "epiLabel", "selectedState" ], "type": "object" } } }, "type": "object" } }, "s4f": { "type": "string", "description": "1 (sf4) or 2 (traditional)", "default": "1" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "0" }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "1" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)", "default": "demovaloriso" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/update": { "post": { "summary": "Merchant Update", "description": "", "operationId": "merchant-update-1", "parameters": [ { "name": "Authorization", "in": "header", "description": "Generated bearer token for ISO login \u003Ca href=\"https://valorapi.readme.io/reference/merchant-create-bearer-token\" target=\"_blank\"\u003E\u003Cb\u003EGenerate Bearer Token\u003C/b\u003E\u003C/a\u003E", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZDliZGU1YWQtZTczNy00MzNiLWJkZDMtMWEwZTk4YjE3NzA0IiwiaWF0IjoxNzMzMjIzMjQ4LCJleHAiOjE3MzMyNTIwNDh9.h1husvYvaP62f9-R8I3hi2b9vyM9bXSmeYWq2E9gQyQ" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userType", "isTxnAllowed", "legalName", "newUserId", "mp_id", "legalState", "dbaName", "firstName", "mobile", "lastName", "ownerName", "emailId", "userName", "legalAddress", "legalCity", "legalCountry", "legalTimezone", "legalZipCode", "role", "sicCode", "storeData", "processor", "rollUp", "selectedState", "s4f" ], "properties": { "businessType": { "type": "string", "description": "Should be sent as business type", "default": "Direct Marketing" }, "userType": { "type": "string", "description": "Should be set as '4' - User type for the merchant", "default": "4" }, "isTxnAllowed": { "type": "string", "description": "Should be set isTxnAllowed default as '1'", "default": "1" }, "legalName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: Quick book dba, Valor Cafe )", "default": "Valor Store" }, "newUserId": { "type": "string", "description": "Merchant User ID (Max length of 11 chars)", "default": "72239" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "43919" }, "legalState": { "type": "string", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "dbaName": { "type": "string", "description": "Max length is 15 char - varchar (Ex: SRM Hardware LLC, Merchant Firm Cafe)", "default": "Valor Store LLC" }, "firstName": { "type": "string", "description": "Max length is 15 char - varchar (First name of the Mechant)", "default": "MERCHANT" }, "mobile": { "type": "string", "description": "Phone number- 10 digit Numeric (Ex: 5247896523)", "default": "8327287578" }, "lastName": { "type": "string", "description": "Max length is 15 char - varchar (Last name of the Mechant)", "default": "PORTAL" }, "ownerName": { "type": "string", "description": "Boarded by ISO & Sub-ISO name - varchar", "default": "MERCHANT PORTAL" }, "emailId": { "type": "string", "description": "Merchant email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "name@protonmail.com" }, "userName": { "type": "string", "description": "Merchant user name (Alphanumeric length of 35 chars)", "default": "merchat310823" }, "legalAddress": { "type": "string", "description": "Legal Address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "legalCity": { "type": "string", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "legalCountry": { "type": "string", "description": "Legal country should be mention default set us US", "default": "US" }, "legalTimezone": { "type": "string", "description": "Sent with (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "legalZipCode": { "type": "string", "description": "Legal zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07010" }, "role": { "type": "string", "description": "Should be set as '10' it is related to role of Merchant", "default": "10" }, "sicCode": { "type": "string", "default": "7230 - Beauty and Barber" }, "storeData": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Store id of Merchant (Max length is 11 char)", "default": "48779" }, "storeName": { "type": "string", "description": "Store name of Merchant (Max length is 15 char)", "default": "Test Store" }, "storeAddress": { "type": "string", "description": "Store address should be max 100 chars - Alphanumeric", "default": "Test Address" }, "storeCity": { "type": "string", "description": "Store city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "default": "CLIFFSIDE PARK" }, "storeState": { "type": "string", "description": "Store state 2 chars of capital (Ex: New York - NY, California - CA)", "default": "NJ" }, "storeCountry": { "type": "string", "description": "Store country should be mention default set us US", "default": "US" }, "storeZipCode": { "type": "string", "description": "Store zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "default": "07010" }, "storeTimezone": { "type": "string", "description": "Sent with (3 char eg: EST,AST,PST,HST,MST)", "default": "EST" }, "superVisorName": { "type": "string", "description": "Name of the supervisor (Max length is 25 char)", "default": "MERCHANT PORTAL LOGIN" }, "superVisorEmail": { "type": "string", "description": "Supervisor email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "default": "vksss.selvam789@gmail.com" }, "superVisorContact": { "type": "string", "description": "Supervisor contact number 10 digit Numeric (Ex: 5247896523)", "default": "8327287578" }, "mccCode": { "type": "string", "description": "It should be 4 digit MCC (Ex: 8765, 5993)", "default": "0742" }, "selectedMCC": { "type": "string", "default": "7230 - Beauty and Barber" }, "descriptors": { "type": "array", "description": "It should be max length 100 chars", "default": [], "items": { "type": "string" } }, "epiData": { "type": "array", "items": { "properties": { "id": { "type": "string", "description": "Merchant EPI profile ID (Max length of 11 chars)", "default": "33182" }, "epi": { "type": "string", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "default": "2319923852" }, "device": { "type": "string", "description": "\u003Cp\u003EThe model description of the device to be boarded for that merchant. Have to pass the 'Device ID'\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice ID\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100\u003C/td\u003E \u003Ctd\u003E130\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003E145\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500\u003C/td\u003E \u003Ctd\u003E136\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP100\u003C/td\u003E \u003Ctd\u003E207\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003E274\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003E139\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP500\u003C/td\u003E \u003Ctd\u003E235\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100 Pro\u003C/td\u003E \u003Ctd\u003E540\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003E533\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550\u003C/td\u003E \u003Ctd\u003E412\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP550E\u003C/td\u003E \u003Ctd\u003E524\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVP800\u003C/td\u003E \u003Ctd\u003E527\u003C/td\u003E \u003C/tr\u003E \u003C/table\u003E", "default": "139" }, "deviceType": { "type": "string", "description": "\u003Cp\u003EThe type description of the device / terminal Possible Options.\u003C/p\u003E \u003Ctable class=\"valor_module_table\"\u003E \u003Ctr\u003E \u003Cth\u003EDevice Name\u003C/th\u003E \u003Cth\u003EDevice Type\u003C/th\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL100, VP100, VL100 Pro\u003C/td\u003E \u003Ctd\u003EDesktop POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL500, VP500, VP550, VP550E, VP800\u003C/td\u003E \u003Ctd\u003ESmart POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL110\u003C/td\u003E \u003Ctd\u003EHandheld POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003ERCKT\u003C/td\u003E \u003Ctd\u003EDONGLE\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVirtual Terminal\u003C/td\u003E \u003Ctd\u003ESoft POS\u003C/td\u003E \u003C/tr\u003E \u003Ctr\u003E \u003Ctd\u003EVL550\u003C/td\u003E \u003Ctd\u003EPortable\u003C/td\u003E \u003C/tr\u003E\u003C/table\u003E", "default": "Soft Pos" }, "processor": { "type": "string", "description": "The processor which supports the merchant to be specified in this field, ProcessorID should be mentioned (Tsys : 1, FD : 2)", "default": "1" }, "epiLabel": { "type": "string", "description": "Label description for the device /terminal. Max length 15 char", "default": "Virtual Terminal" }, "is_status": { "type": "integer", "description": "\"is_status\" value must be either 0 or 1, where 0 means \"Deactivate\" and 1 means \"Activate\".", "default": 1, "format": "int32" }, "processorData": { "type": "array", "items": { "properties": { "mid": { "type": "string", "description": "Merchant id related to the surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "887000003193" }, "mid1": { "type": "string", "description": "Merchant id related to the traditional profile. If the epi is to be boarded on surcharge Profile sets it as \"null\"", "default": "\"\"", "format": "json" }, "vNumber": { "type": "string", "description": "vNumber mapped to the particular device / terminal in surcharge profile. If the epi is to be boarded on Traditional profile set it as \"null\"", "default": "75021674" }, "vNumber1": { "type": "string", "description": "vNumber mapped to the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "storeNo": { "type": "string", "description": "Store number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "5999" }, "storeNo1": { "type": "string", "description": "Store number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "termNo": { "type": "string", "description": "Terminal number of the particular device / terminal in surcharge profile. If the epi is to be boarded on traditional Profile set it as \"null\"", "default": "1515" }, "termNo1": { "type": "string", "description": "Terminal number of the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "association": { "type": "string", "description": "Association number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "949006" }, "association1": { "type": "string", "description": "Association number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "chain": { "type": "string", "description": "Chain number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "111111" }, "chain1": { "type": "string", "description": "Chain number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agent": { "type": "string", "description": "Agent code number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "0001" }, "agent1": { "type": "string", "description": "Agent code number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo": { "type": "string", "description": "Ebt number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EbtNo1": { "type": "string", "description": "Ebt number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "binnumber": { "type": "string", "description": "Bin number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "999991" }, "binnumber1": { "type": "string", "description": "Bin number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "agentBank": { "type": "string", "description": "Agent bank number for the particular device / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "000000" }, "agentBank1": { "type": "string", "description": "Agent bank number for the particular device / terminal in traditional profile. If the epi is to be boarded on a Surcharge profile, set it as \"null\"", "default": "\"\"", "format": "json" }, "industry": { "type": "string", "description": "The industry type on which the terminal / terminal in surcharge profile. If the epi is to be boarded on a traditional Profile set it as \"null\"", "default": "Retail" }, "industry1": { "type": "string", "description": "The industry type on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as \"null\"", "default": "\"\"", "format": "json" }, "EBTcash": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTcash1": { "type": "integer", "description": "The EBT cash on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "EBTfood1": { "type": "integer", "description": "The EBT food on which the terminal / device to be boarded in traditional profile. If the epi is to be boarded on a surcharge Profile set it as 0 or 1", "default": 0, "format": "int32" }, "surchargeIndicator": { "type": "integer", "description": "The value '0' means % and 1 means dollar", "default": 0, "format": "int32" }, "surchargePercentage": { "type": "string", "description": "If the epi is to be boarded on a traditional Profile set it as \"null\". Surcharge indicator % means the value should be (3.000) and dollar (3.00)", "default": "4.00" }, "label": { "type": "string", "description": "The storename on which the device/terminal created is mapped on this field", "default": "MERCHANT PORTAL LOGIN" }, "programType": { "type": "string", "description": "If program type set as \"surcharge\" or \"cashdiscount\".", "default": "surcharge" } }, "required": [ "mid", "mid1", "vNumber", "vNumber1", "storeNo", "storeNo1", "termNo", "association", "association1", "chain", "chain1", "agent", "agent1", "EbtNo", "EbtNo1", "binnumber", "binnumber1", "agentBank", "agentBank1", "industry", "industry1", "EBTcash", "EBTcash1", "EBTfood1", "surchargeIndicator", "surchargePercentage", "label", "programType" ], "type": "object" } }, "batch_number": { "type": "string" } }, "required": [ "id", "epi", "device", "deviceType", "processor", "epiLabel", "is_status" ], "type": "object" } } }, "required": [ "storeName", "storeAddress", "storeCity", "storeState", "storeCountry", "storeZipCode", "storeTimezone", "superVisorName", "superVisorEmail", "superVisorContact", "mccCode", "selectedMCC", "descriptors" ], "type": "object" } }, "processor": { "type": "string", "description": "Update the processor params 1 or 2 (TSYS - 1 and FD - 2)", "default": "1" }, "rollUp": { "type": "string", "description": "Set value 0 or 1 (This value allows merchants to access the virtual terminal free of charge for 6 months)", "default": "0" }, "selectedState": { "type": "string", "description": "The State which is selected to be sent on it with the State code", "default": "NJ" }, "s4f": { "type": "string", "default": "1" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": { } } } } } }, "deprecated": false } }, "/api/valor/delete": { "post": { "summary": "Merchant Delete", "description": "", "operationId": "merchant-delete-1", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "default": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1MjMyMywidXNlcl90eXBlX2lkIjoyLCJwZXJtaXNzaW9ucyI6WyJtb2R1bGVzOioiLCJ1c2VyOmlzbyJdLCJzZXNzaW9uX2lkIjoiZjA5Yjg4YTEtZTc0Ni00NTlkLWE0ZDYtODcyNjc3NWVlMTI3IiwiaWF0IjoxNzMzMjEyMzU5LCJleHAiOjE3MzMyNDExNTl9.pQDWAyyA1opea22QnUWMb1ih5f525apHv-KvHkThTx8" } }, { "name": "isv-secret-key", "in": "header", "description": "ISV secret key", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "mp_id" ], "properties": { "userName": { "type": "string", "description": "ISO user name (Alphanumeric length of 25 chars)", "default": "isousername" }, "mp_id": { "type": "string", "description": "It is a merchant profile id which is respective to the particular merchant (Max length of 11 chars)", "default": "44177" }, "associate_user_name": { "type": "string", "description": "ISO user name (Alphanumeric length of 35 chars)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": true,\n \"message\": \"Success\",\n \"code\": 200\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "boolean", "example": true, "default": true }, "message": { "type": "string", "example": "Success" }, "code": { "type": "integer", "example": 200, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": 400,\n \"status\": false,\n \"message\": \"Given Username is already deleted\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 400, "default": 0 }, "status": { "type": "boolean", "example": false, "default": true }, "message": { "type": "string", "example": "Given Username is already deleted" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true }