{ "openapi": "3.1.0", "info": { "title": "Virtual Terminal", "version": "1.0" }, "servers": [ { "url": "https://vt-staging.valorpaytech.com:4430?" } ], "components": { "securitySchemes": { } }, "security": [ { } ], "paths": { "/?authonly": { "post": { "summary": "AuthOnly API", "description": "", "operationId": "authonly-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "mtype", "in": "query", "description": "Message type for 0100 is authorization request (Pre Auth)", "required": true, "schema": { "type": "string", "default": "0100" } }, { "name": "amount", "in": "query", "description": "Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)", "required": true, "schema": { "type": "number", "format": "double", "default": 567.67 } }, { "name": "pan", "in": "query", "description": "Customer card number 15 to 19 digits", "required": true, "schema": { "type": "integer", "format": "int32", "default": 4111111111111111 } }, { "name": "expiry_date", "in": "query", "description": "Card expiry date, Accepted expiry MMYY & MM/YY (The expiration date must be exactly 4 characters long, consisting of a 2-digit month (with a leading zero if necessary) followed by a 2-digit year (e.g., \"0526\"))", "required": true, "schema": { "type": "string", "format": "date", "default": "1224" } }, { "name": "cvv", "in": "query", "description": "Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)", "schema": { "type": "string", "default": "999" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "food_amount", "in": "query", "description": "Currency $(Eg. 00.00) - Food amount should be less than to transaction amount", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "city_tax", "in": "query", "description": "City tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "reduced_tax", "in": "query", "description": "City tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "custom_fee", "in": "query", "description": "Additional fee of surcharge amount - Currency $ (Eg: 10.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "card_holder_name", "in": "query", "description": "Name of the cardholder - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_customerName", "in": "query", "description": "Shipping address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "b_customerName", "in": "query", "description": "Billing address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "recursivePaymentId", "in": "query", "description": "Customer unique recursive payment id (subscription id) (Numeric - Max length of 11 chars)", "schema": { "type": "integer", "format": "int32" } }, { "name": "avs", "in": "query", "description": "Address verification service (zip, street address - Numeric length of 1 chars)", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "string" } }, { "name": "recursivePayment", "in": "query", "description": "Is recursive payment true or false", "schema": { "type": "boolean", "default": false } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Customer user name (Alphanumeric length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_street_no", "in": "query", "description": "Shipping address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "integer", "format": "int32" } }, { "name": "s_street_name", "in": "query", "description": "Shipping address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "s_unit", "in": "query", "description": "Shipping address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "s_city", "in": "query", "description": "Shipping address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "s_state", "in": "query", "description": "Shipping address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "s_zip", "in": "query", "description": "Shipping address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "integer", "format": "int32" } }, { "name": "b_street_no", "in": "query", "description": "Billing address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "integer", "format": "int32" } }, { "name": "b_street_name", "in": "query", "description": "Billing address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "b_unit", "in": "query", "description": "Billing address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "b_city", "in": "query", "description": "Billing address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "b_state", "in": "query", "description": "Billing address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "b_zip", "in": "query", "description": "Billing address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderId", "in": "query", "description": "Transaction order id for sale and auth (Length of max 11 chars)", "schema": { "type": "integer", "format": "int32" } }, { "name": "invoicenumber", "in": "query", "description": "Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)", "schema": { "type": "integer", "format": "int32" } }, { "name": "dataset_id", "in": "query", "description": "Line item against created dataset id (Numeric -Max length of 20 chars, Ex: 364, 370 )", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderdescription", "in": "query", "description": "Add the order description - Optional (Alphanumeric - Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "validateCard", "in": "query", "description": "Validate the card default set as 1", "schema": { "type": "string", "default": "0" } }, { "name": "userid", "in": "query", "description": "Customer user id - Numeric max length of 11 chars", "schema": { "type": "integer", "format": "int32", "default": 15625 } }, { "name": "surchargeRemoved", "in": "query", "description": "To remove the surcharge fee set value 0 else set 1", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"success_url\": true,\n \"error_code\": \"00\",\n \"amount\": \"567.67\",\n \"tax\": \"0\",\n \"customfee\": \"0\",\n \"msg\": \"APPROVED\",\n \"desc\": \"APPROVAL TAS168 \",\n \"additional_info\": null,\n \"clerk_id\": null,\n \"clerk_name\": null,\n \"clerk_label\": null,\n \"additionalKeyOne\": null,\n \"additionalKeyTwo\": null,\n \"additionalValueOne\": null,\n \"additionalValueTwo\": null,\n \"approval_code\": \"TAS168\",\n \"rrn\": \"328510502516\",\n \"txnid\": \"5217512\",\n \"tran_no\": 9,\n \"stan\": 105,\n \"is_partial_approve\": 0,\n \"partial_amount\": \"000000056767\",\n \"pan\": \"XXXX1111\",\n \"card_type\": null,\n \"phone_number\": null,\n \"email_id\": null,\n \"zip\": null,\n \"card_holder_name\": null,\n \"expiry_date\": \"12/23\",\n \"address\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\",\n \"token\": \"1A49C2448DF860E0D5457C6672C2A38B3DE2D941\",\n \"card_brand\": null,\n \"netamt\": 567.67\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "success_url": { "type": "boolean", "example": true, "default": true }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "567.67" }, "tax": { "type": "string", "example": "0" }, "customfee": { "type": "string", "example": "0" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": "APPROVAL TAS168 " }, "additional_info": { }, "clerk_id": { }, "clerk_name": { }, "clerk_label": { }, "additionalKeyOne": { }, "additionalKeyTwo": { }, "additionalValueOne": { }, "additionalValueTwo": { }, "approval_code": { "type": "string", "example": "TAS168" }, "rrn": { "type": "string", "example": "328510502516" }, "txnid": { "type": "string", "example": "5217512" }, "tran_no": { "type": "integer", "example": 9, "default": 0 }, "stan": { "type": "integer", "example": 105, "default": 0 }, "is_partial_approve": { "type": "integer", "example": 0, "default": 0 }, "partial_amount": { "type": "string", "example": "000000056767" }, "pan": { "type": "string", "example": "XXXX1111" }, "card_type": { }, "phone_number": { }, "email_id": { }, "zip": { }, "card_holder_name": { }, "expiry_date": { "type": "string", "example": "12/23" }, "address": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" }, "token": { "type": "string", "example": "1A49C2448DF860E0D5457C6672C2A38B3DE2D941" }, "card_brand": { }, "netamt": { "type": "number", "example": 567.67, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E98\",\n \"error_code\": \"96\",\n \"success_url\": false,\n \"txnid\": \"5217620\",\n \"switch_error_code\": \"V0417\",\n \"mesg\": \"Transaction ISO Validations Failed.\",\n \"desc\": \"Error code :96\",\n \"msg\": \"Transaction ISO Validations Failed.\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E98" }, "error_code": { "type": "string", "example": "96" }, "success_url": { "type": "boolean", "example": false, "default": true }, "txnid": { "type": "string", "example": "5217620" }, "switch_error_code": { "type": "string", "example": "V0417" }, "mesg": { "type": "string", "example": "Transaction ISO Validations Failed." }, "desc": { "type": "string", "example": "Error code :96" }, "msg": { "type": "string", "example": "Transaction ISO Validations Failed." } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { }, "examples": { "Request Example": { "value": { "mailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "SubmailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "passCode": "Valor@123", "mp_id": "15625", "epi": "2227241967" } } } } } } } }, "/?captureapi": { "post": { "summary": "Capture API", "description": "", "operationId": "capture-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "mtype", "in": "query", "description": "Transaction type should be set as 'capture'", "required": true, "schema": { "type": "string", "default": "capture" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "rrn", "in": "query", "description": "RRN number from sale txn response (Numeric - Max length of 15 chars)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "auth_code", "in": "query", "description": "Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)", "required": true, "schema": { "type": "string" } }, { "name": "stan", "in": "query", "description": "STAN number (Numeric - Max length of 6 chars)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tran_no", "in": "query", "description": "Should match the original sale tran_no (Numeric - Max length of chars 11)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "amount", "in": "query", "description": "Add excess two zero for original capture transaction amount (Ex: 10.00 means 1000)", "required": true, "schema": { "type": "number", "format": "double", "default": 67.77 } }, { "name": "pos_entry_mode", "in": "query", "description": "Mode of transaction in POS terminal", "required": true, "schema": { "type": "integer", "format": "int32", "default": 12 } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "integer", "format": "int32" } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "city_tax", "in": "query", "description": "City tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "custom_fee", "in": "query", "description": "Custom fee/surcharge fee if any - Add excess two zero for original amount (ex: 5.00 means 500)", "schema": { "type": "number", "format": "double", "default": 14 } }, { "name": "tip_amount", "in": "query", "description": "Tip if any - Optional (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"success_url\": true,\n \"error_code\": \"00\",\n \"amount\": \"5.67\",\n \"tax\": \"0\",\n \"customfee\": \"14\",\n \"msg\": \"APPROVED\",\n \"desc\": \"APPROVAL TAS168 \",\n \"additional_info\": null,\n \"clerk_id\": null,\n \"clerk_name\": null,\n \"clerk_label\": null,\n \"additionalKeyOne\": null,\n \"additionalKeyTwo\": null,\n \"additionalValueOne\": null,\n \"additionalValueTwo\": null,\n \"approval_code\": \"TAS168\",\n \"rrn\": \"328510502516\",\n \"txnid\": \"5217748\",\n \"tran_no\": 9,\n \"stan\": 105,\n \"is_partial_approve\": 0,\n \"partial_amount\": \"000000000567\",\n \"pan\": \"XXXX\",\n \"card_type\": null,\n \"phone_number\": null,\n \"email_id\": null,\n \"zip\": null,\n \"card_holder_name\": null,\n \"expiry_date\": \"/\",\n \"address\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\",\n \"token\": null,\n \"card_brand\": null,\n \"netamt\": 19.67\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "success_url": { "type": "boolean", "example": true, "default": true }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "5.67" }, "tax": { "type": "string", "example": "0" }, "customfee": { "type": "string", "example": "14" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": "APPROVAL TAS168 " }, "additional_info": { }, "clerk_id": { }, "clerk_name": { }, "clerk_label": { }, "additionalKeyOne": { }, "additionalKeyTwo": { }, "additionalValueOne": { }, "additionalValueTwo": { }, "approval_code": { "type": "string", "example": "TAS168" }, "rrn": { "type": "string", "example": "328510502516" }, "txnid": { "type": "string", "example": "5217748" }, "tran_no": { "type": "integer", "example": 9, "default": 0 }, "stan": { "type": "integer", "example": 105, "default": 0 }, "is_partial_approve": { "type": "integer", "example": 0, "default": 0 }, "partial_amount": { "type": "string", "example": "000000000567" }, "pan": { "type": "string", "example": "XXXX" }, "card_type": { }, "phone_number": { }, "email_id": { }, "zip": { }, "card_holder_name": { }, "expiry_date": { "type": "string", "example": "/" }, "address": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" }, "token": { }, "card_brand": { }, "netamt": { "type": "number", "example": 19.67, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E98\",\n \"error_code\": \"VI\",\n \"success_url\": false,\n \"txnid\": null,\n \"switch_error_code\": null,\n \"mesg\": \" \",\n \"desc\": \"Error code :VI\",\n \"msg\": \" \"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E98" }, "error_code": { "type": "string", "example": "VI" }, "success_url": { "type": "boolean", "example": false, "default": true }, "txnid": { }, "switch_error_code": { }, "mesg": { "type": "string", "example": " " }, "desc": { "type": "string", "example": "Error code :VI" }, "msg": { "type": "string", "example": " " } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { }, "examples": { "Request Example": { "value": { "mailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "SubmailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "passCode": "Valor@123", "mp_id": "15625", "epi": "2227241967" } } } } } } } }, "/?saleapi": { "post": { "summary": "Sale API", "description": "", "operationId": "sale-api-1", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "mtype", "in": "query", "description": "Message type for 0200 is sale transaction request", "required": true, "schema": { "type": "string", "default": "0200" } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "string" } }, { "name": "amount", "in": "query", "description": "Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)", "required": true, "schema": { "type": "number", "format": "double", "default": 11.11 } }, { "name": "pan", "in": "query", "description": "Customer card number 15 to 19 digits", "required": true, "schema": { "type": "integer", "format": "int32", "default": 4111111111111111 } }, { "name": "expiry_date", "in": "query", "description": "Card expiry date, Accepted expiry MMYY & MM/YY (The expiration date must be exactly 4 characters long, consisting of a 2-digit month (with a leading zero if necessary) followed by a 2-digit year (e.g., \"0526\"))", "required": true, "schema": { "type": "string", "format": "date", "default": "1224" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "food_amount", "in": "query", "description": "Currency $(Eg. 00.00) - Food amount should be less than to transaction amount", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0.44 } }, { "name": "city_tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "reduced_tax", "in": "query", "description": "City tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "custom_fee", "in": "query", "description": "Additional fee of surcharge amount - Currency $ (Eg: 10.00)", "schema": { "type": "number", "format": "double", "default": 0.02 } }, { "name": "cvv", "in": "query", "description": "Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)", "schema": { "type": "integer", "format": "int32", "default": 999 } }, { "name": "surchargeRemoved", "in": "query", "description": "To remove the surcharge fee set value 0 else set 1", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "card_holder_name", "in": "query", "description": "Name of the cardholder - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_customerName", "in": "query", "description": "Shipping address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "b_customerName", "in": "query", "description": "Billing address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "recursivePaymentId", "in": "query", "description": "Customer unique recursive payment id (subscription id) (Numeric - Max length of 11 chars)", "schema": { "type": "string" } }, { "name": "avs", "in": "query", "description": "Address verification service (zip, street address - Numeric length of one chars)", "schema": { "type": "string", "default": "1" } }, { "name": "recursivePayment", "in": "query", "description": "Is recursive payment set as true or false (Boolean)", "schema": { "type": "boolean", "default": false } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "integer", "format": "int32" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Customer user name (Alphanumeric length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_street_no", "in": "query", "description": "Shipping address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string" } }, { "name": "s_street_name", "in": "query", "description": "Shipping address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "s_unit", "in": "query", "description": "Shipping address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "s_city", "in": "query", "description": "Shipping address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "s_state", "in": "query", "description": "Shipping address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "s_zip", "in": "query", "description": "Shipping address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string" } }, { "name": "b_street_no", "in": "query", "description": "Billing address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string" } }, { "name": "b_street_name", "in": "query", "description": "Billing address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "b_unit", "in": "query", "description": "Billing address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "b_city", "in": "query", "description": "Billing address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "b_state", "in": "query", "description": "Billing address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "b_zip", "in": "query", "description": "Billing address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string" } }, { "name": "orderId", "in": "query", "description": "Transaction order id for sale and auth (Length of max 11 chars)", "schema": { "type": "integer", "format": "int32" } }, { "name": "invoicenumber", "in": "query", "description": "Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)", "schema": { "type": "integer", "format": "int32" } }, { "name": "dataset_id", "in": "query", "description": "Line item against created dataset id (Numeric -Max length of 20 chars, Ex: 364, 370 )", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderdescription", "in": "query", "description": "Add the order description - Optional (Alphanumeric - Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "validateCard", "in": "query", "description": "Validate the card default set as 1", "schema": { "type": "string", "default": "0" } }, { "name": "userid", "in": "query", "description": "Customer user id - Numeric max length of 11 chars", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"success_url\": true,\n \"error_code\": \"00\",\n \"amount\": \"11.11\",\n \"tax\": \"0.44\",\n \"customfee\": \"0.02\",\n \"msg\": \"APPROVED\",\n \"desc\": \"APPROVAL TAS849 \",\n \"additional_info\": null,\n \"clerk_id\": null,\n \"clerk_name\": null,\n \"clerk_label\": null,\n \"additionalKeyOne\": null,\n \"additionalKeyTwo\": null,\n \"additionalValueOne\": null,\n \"additionalValueTwo\": null,\n \"approval_code\": \"TAS849\",\n \"rrn\": \"328510500810\",\n \"txnid\": \"5217792\",\n \"tran_no\": 13,\n \"stan\": 131,\n \"is_partial_approve\": 0,\n \"partial_amount\": \"000000001111\",\n \"pan\": \"XXXX1111\",\n \"card_type\": null,\n \"phone_number\": null,\n \"email_id\": null,\n \"zip\": null,\n \"card_holder_name\": null,\n \"expiry_date\": \"12/24\",\n \"address\": null,\n \"epi\": \"2226388434\",\n \"channel\": \"VT\",\n \"token\": \"CE1B97D46F283B204C044DC474AAA70A749270AE\",\n \"card_brand\": \"Visa\",\n \"netamt\": 11.569999999999999\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "success_url": { "type": "boolean", "example": true, "default": true }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "11.11" }, "tax": { "type": "string", "example": "0.44" }, "customfee": { "type": "string", "example": "0.02" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": "APPROVAL TAS849 " }, "additional_info": { }, "clerk_id": { }, "clerk_name": { }, "clerk_label": { }, "additionalKeyOne": { }, "additionalKeyTwo": { }, "additionalValueOne": { }, "additionalValueTwo": { }, "approval_code": { "type": "string", "example": "TAS849" }, "rrn": { "type": "string", "example": "328510500810" }, "txnid": { "type": "string", "example": "5217792" }, "tran_no": { "type": "integer", "example": 13, "default": 0 }, "stan": { "type": "integer", "example": 131, "default": 0 }, "is_partial_approve": { "type": "integer", "example": 0, "default": 0 }, "partial_amount": { "type": "string", "example": "000000001111" }, "pan": { "type": "string", "example": "XXXX1111" }, "card_type": { }, "phone_number": { }, "email_id": { }, "zip": { }, "card_holder_name": { }, "expiry_date": { "type": "string", "example": "12/24" }, "address": { }, "epi": { "type": "string", "example": "2226388434" }, "channel": { "type": "string", "example": "VT" }, "token": { "type": "string", "example": "CE1B97D46F283B204C044DC474AAA70A749270AE" }, "card_brand": { "type": "string", "example": "Visa" }, "netamt": { "type": "number", "example": 11.57, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E26\",\n \"mesg\": \"PROCESSING ERROR\",\n \"msg\": \"PROCESSING ERROR\",\n \"desc\": \"AUTHENTICATION FAILED\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E26" }, "mesg": { "type": "string", "example": "PROCESSING ERROR" }, "msg": { "type": "string", "example": "PROCESSING ERROR" }, "desc": { "type": "string", "example": "AUTHENTICATION FAILED" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { }, "examples": { "Request Example": { "value": { "mailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "SubmailId": "dineshkumar+merchant-VSRT@valorpaytech.com", "passCode": "Valor@123", "mp_id": "15625", "epi": "2227241967" } } } } } } } }, "/?settlementapi": { "post": { "summary": "Settlement API", "description": "", "operationId": "settlement-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "userid", "in": "query", "description": "It is the userid of the merchant to be updated", "schema": { "type": "integer", "format": "int32" } }, { "name": "mtype", "in": "query", "description": "Set the message type as '0200' (length of 3 chars)", "required": true, "schema": { "type": "string", "default": "settlement" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"error_code\": \"00\",\n \"amount\": \"0.00\",\n \"msg\": \"APPROVED\",\n \"desc\": null,\n \"additional_info\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "0.00" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { }, "additional_info": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E04\",\n \"mesg\": \"PROCESSING ERROR\",\n \"msg\": \"PROCESSING ERROR\",\n \"desc\": \"INVALID MESSAGE CODE\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E04" }, "mesg": { "type": "string", "example": "PROCESSING ERROR" }, "msg": { "type": "string", "example": "PROCESSING ERROR" }, "desc": { "type": "string", "example": "INVALID MESSAGE CODE" } } } } } } }, "deprecated": false, "requestBody": { "content": { "application/json": { "schema": { }, "examples": { "Request Example": { "value": { "mailId": "hazikvalor+fxd@gmail.com", "SubmailId": "hazikvalor+fxd@gmail.com", "passCode": "Valor123", "mp_id": "8945", "epi": "2206214735" } } } } } } } }, "/?void": { "post": { "summary": "Void API", "description": "", "operationId": "void-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "mtype", "in": "query", "description": "Message type should be set as 'void'", "required": true, "schema": { "type": "string", "default": "void" } }, { "name": "rrn", "in": "query", "description": "RRN number from sale txn response (Numeric - Max length of 15 chars)", "required": true, "schema": { "type": "string" } }, { "name": "auth_code", "in": "query", "description": "Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)", "required": true, "schema": { "type": "string" } }, { "name": "tran_no", "in": "query", "description": "Should match the original sale tran_no (Numeric - Max length of chars 11)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "stan", "in": "query", "description": "STAN number (Numeric - Max length of 6 chars)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "amount", "in": "query", "description": "Add excess two zero for original void transaction amount (ex: 10.00 means 1000)", "required": true, "schema": { "type": "number", "format": "double", "default": 1000 } }, { "name": "pos_entry_mode", "in": "query", "description": "Mode of transaction in POS terminal (Numeric - length of max chars)", "required": true, "schema": { "type": "string", "default": "012" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pos_condition_code", "in": "query", "description": "Check the condition of transaction (length of max 3 chars)", "schema": { "type": "integer", "format": "int32", "default": 8 } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "string" } }, { "name": "userid", "in": "query", "description": "Customer user id - Numeric max length of 11 chars", "schema": { "type": "string", "default": "12043" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "string" } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "custom_fee", "in": "query", "description": "Custom fee/surcharge fee if any - Add excess two zero for original amount (ex: 5.00 means 500)", "schema": { "type": "number", "format": "double", "default": 10 } }, { "name": "tip_amount", "in": "query", "description": "Tip if any - Optional (Eg. 00.00)", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"error_code\": \"00\",\n \"amount\": \"567.67\",\n \"msg\": \"APPROVED\",\n \"desc\": \"APPROVAL TAS191 \",\n \"additional_info\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\",\n \"rrn\": \"328604501386\",\n \"txnid\": \"5221304\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "567.67" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": "APPROVAL TAS191 " }, "additional_info": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" }, "rrn": { "type": "string", "example": "328604501386" }, "txnid": { "type": "string", "example": "5221304" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E98\",\n \"error_code\": \"12\",\n \"success_url\": false,\n \"txnid\": \"5221272\",\n \"switch_error_code\": \"V0543\",\n \"mesg\": \"Original transaction not found\",\n \"desc\": \"Error code :12\",\n \"msg\": \"Original transaction not found\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E98" }, "error_code": { "type": "string", "example": "12" }, "success_url": { "type": "boolean", "example": false, "default": true }, "txnid": { "type": "string", "example": "5221272" }, "switch_error_code": { "type": "string", "example": "V0543" }, "mesg": { "type": "string", "example": "Original transaction not found" }, "desc": { "type": "string", "example": "Error code :12" }, "msg": { "type": "string", "example": "Original transaction not found" } } } } } } }, "deprecated": false } }, "/?listsubsc": { "post": { "summary": "List Subscription API", "description": "", "operationId": "list-subscription-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "subscription_id", "in": "query", "description": "Subscription id (length of max 11 chars)", "required": true, "schema": { "type": "string", "default": "18262" } }, { "name": "mtype", "in": "query", "description": "Message type should be set as 'listsubscription'", "required": true, "schema": { "type": "string", "default": "listsubscription" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "active", "in": "query", "description": "Activate status for either true or false", "schema": { "type": "string", "default": "true" } }, { "name": "start_date", "in": "query", "description": "Subscription start date accepted expiry MM/DD/YY", "schema": { "type": "string", "default": "04/01/23" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"records\": [\n {\n \"subscription_id\": \"11738\",\n \"amount\": \"200\",\n \"custom_fee\": \"3.5000\",\n \"tax\": \"5.0300\",\n \"invoice_number\": \"\",\n \"product_description\": \"\",\n \"shipping_customer_name\": \"bevin\",\n \"shipping_street_no\": \"2nd Avenue\",\n \"shipping_street_name\": \"Newland\",\n \"shipping_unit\": \"2\",\n \"shipping_city\": \"\",\n \"shipping_state\": \"\",\n \"shipping_zipcode\": \"50001\",\n \"billing_customerName\": \"bevin\",\n \"billing_street_no\": \"2nd Avenue\",\n \"billing_street_name\": \"Newland\",\n \"billing_unit\": \"2\",\n \"billing_city\": \"\",\n \"billing_state\": \"\",\n \"billing_zipcode\": \"50001\",\n \"subscription_day_of_the_month\": \"20\",\n \"subscription_starts_from\": \"2023-10-03\",\n \"subscription_valid_for\": \"6\",\n \"phone\": \"\",\n \"email\": \"\",\n \"no_of_failed_attempts\": \"0\",\n \"status\": \"1\",\n \"card_number\": \"XXXX1111\",\n \"total_no_of_payments\": \"0\",\n \"forfeit\": \"0\",\n \"forfeit_date\": null\n }\n ],\n \"error_no\": \"S00\",\n \"error_code\": \"00\"\n}" } }, "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "type": "object", "properties": { "subscription_id": { "type": "string", "example": "11738" }, "amount": { "type": "string", "example": "200" }, "custom_fee": { "type": "string", "example": "3.5000" }, "tax": { "type": "string", "example": "5.0300" }, "invoice_number": { "type": "string", "example": "" }, "product_description": { "type": "string", "example": "" }, "shipping_customer_name": { "type": "string", "example": "bevin" }, "shipping_street_no": { "type": "string", "example": "2nd Avenue" }, "shipping_street_name": { "type": "string", "example": "Newland" }, "shipping_unit": { "type": "string", "example": "2" }, "shipping_city": { "type": "string", "example": "" }, "shipping_state": { "type": "string", "example": "" }, "shipping_zipcode": { "type": "string", "example": "50001" }, "billing_customerName": { "type": "string", "example": "bevin" }, "billing_street_no": { "type": "string", "example": "2nd Avenue" }, "billing_street_name": { "type": "string", "example": "Newland" }, "billing_unit": { "type": "string", "example": "2" }, "billing_city": { "type": "string", "example": "" }, "billing_state": { "type": "string", "example": "" }, "billing_zipcode": { "type": "string", "example": "50001" }, "subscription_day_of_the_month": { "type": "string", "example": "20" }, "subscription_starts_from": { "type": "string", "example": "2023-10-03" }, "subscription_valid_for": { "type": "string", "example": "6" }, "phone": { "type": "string", "example": "" }, "email": { "type": "string", "example": "" }, "no_of_failed_attempts": { "type": "string", "example": "0" }, "status": { "type": "string", "example": "1" }, "card_number": { "type": "string", "example": "XXXX1111" }, "total_no_of_payments": { "type": "string", "example": "0" }, "forfeit": { "type": "string", "example": "0" }, "forfeit_date": { } } } }, "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E31\",\n \"mesg\": \"PROCESSING ERROR\",\n \"msg\": \"PROCESSING ERROR\",\n \"desc\": \"NO SUBSCRIPTION AVAILABLE\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E31" }, "mesg": { "type": "string", "example": "PROCESSING ERROR" }, "msg": { "type": "string", "example": "PROCESSING ERROR" }, "desc": { "type": "string", "example": "NO SUBSCRIPTION AVAILABLE" } } } } } } }, "deprecated": false } }, "/?getopenbatch": { "post": { "summary": "Open Batch Details", "description": "", "operationId": "open-batch-details", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "464DA39FCFB44D54F6C1D22CEF9098E5" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "15B8BCFDB337428792608354A1444050" } }, { "name": "mtype", "in": "query", "description": "Message type should be set as 'getopenbatch'", "required": true, "schema": { "type": "string", "default": "getopenbatch" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2235451562" } }, { "name": "limit", "in": "query", "description": "Limit for pagination. Max 50 and default 0", "required": true, "schema": { "type": "integer", "format": "int32", "default": 20 } }, { "name": "offset", "in": "query", "description": "Offset for pagination. Default 0", "required": true, "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"SUCCESS\",\n \"statusMsg\": \"Open batch request success\",\n \"batchSummary\": [\n {\n \"dashboard_netamount\": 1298,\n \"dashboard_batchcount\": 3\n }\n ],\n \"batchSummaryDetails\": [\n {\n \"tip_adjusted_count\": 0,\n \"txn_id\": 5221108,\n \"invoice_mode\": null,\n \"epi_id\": \"2235451562\",\n \"message_type\": \"0200\",\n \"processing_code\": \"000000\",\n \"txn_type\": \"SALE\",\n \"txn_type_code\": 101,\n \"amount\": 100,\n \"tip_amount\": 0,\n \"cashback_amount\": 0,\n \"custom_fee_amount\": 3,\n \"isnew_txn\": 0,\n \"surcharge_fee_amount\": 0,\n \"merchant_fee_amount\": 0,\n \"tax_amount\": 0,\n \"tip_fee_amount\": 0,\n \"tax_fee_amount\": 0,\n \"city_tax_amount\": 0,\n \"state_tax_amount\": 5,\n \"original_amount\": 0,\n \"tran_no\": 3,\n \"stan_no\": \"312\",\n \"invoice_no\": \"3\",\n \"batch_no\": \"151\",\n \"pos_entry_mode\": \"012\",\n \"masked_card_no\": \"4386 XXXX XXXX 8273\",\n \"card_scheme\": \"Visa\",\n \"request_date\": \"10-13-2023\",\n \"request_time\": \"03:38 AM\",\n \"store_time_zone\": \"EST\",\n \"mid\": \"887000003190\",\n \"tid\": \"00000013\",\n \"rrn\": \"328607753675\",\n \"approval_code\": \"TAS725\",\n \"card_menu_selection\": \"1\",\n \"response_code\": \"00\",\n \"switch_response_code\": \"00\",\n \"settlement_mode\": null,\n \"settled_at\": \"2023-10-13T07:38:01.000Z\",\n \"batches_id\": null,\n \"surver_answer\": 2,\n \"additional_doc1\": null,\n \"is_voided\": 0,\n \"is_auth_completed\": 0,\n \"created_at\": \"2023-10-13T07:38:01.000Z\",\n \"txamount\": 108,\n \"surcharge_label\": \"Non-Cash Charge\"\n },\n {\n \"tip_adjusted_count\": 0,\n \"txn_id\": 5220452,\n \"invoice_mode\": null,\n \"epi_id\": \"2235451562\",\n \"message_type\": \"0200\",\n \"processing_code\": \"000000\",\n \"txn_type\": \"SALE\",\n \"txn_type_code\": 101,\n \"amount\": 1000,\n \"tip_amount\": 0,\n \"cashback_amount\": 0,\n \"custom_fee_amount\": 30,\n \"isnew_txn\": 0,\n \"surcharge_fee_amount\": 0,\n \"merchant_fee_amount\": 0,\n \"tax_amount\": 0,\n \"tip_fee_amount\": 0,\n \"tax_fee_amount\": 0,\n \"city_tax_amount\": 0,\n \"state_tax_amount\": 52,\n \"original_amount\": 0,\n \"tran_no\": 2,\n \"stan_no\": \"256\",\n \"invoice_no\": \"2\",\n \"batch_no\": \"151\",\n \"pos_entry_mode\": \"012\",\n \"masked_card_no\": \"4111 XXXX XXXX 1111\",\n \"card_scheme\": \"Visa\",\n \"request_date\": \"10-13-2023\",\n \"request_time\": \"02:38 AM\",\n \"store_time_zone\": \"EST\",\n \"mid\": \"887000003190\",\n \"tid\": \"00000013\",\n \"rrn\": \"328606504922\",\n \"approval_code\": \"TAS373\",\n \"card_menu_selection\": \"1\",\n \"response_code\": \"00\",\n \"switch_response_code\": \"00\",\n \"settlement_mode\": null,\n \"settled_at\": \"2023-10-13T06:38:05.000Z\",\n \"batches_id\": null,\n \"surver_answer\": 1,\n \"additional_doc1\": null,\n \"is_voided\": 0,\n \"is_auth_completed\": 0,\n \"created_at\": \"2023-10-13T06:38:05.000Z\",\n \"txamount\": 1082,\n \"surcharge_label\": \"Non-Cash Charge\"\n },\n {\n \"tip_adjusted_count\": 0,\n \"txn_id\": 5220244,\n \"invoice_mode\": null,\n \"epi_id\": \"2235451562\",\n \"message_type\": \"0200\",\n \"processing_code\": \"000000\",\n \"txn_type\": \"SALE\",\n \"txn_type_code\": 101,\n \"amount\": 100,\n \"tip_amount\": 0,\n \"cashback_amount\": 0,\n \"custom_fee_amount\": 3,\n \"isnew_txn\": 0,\n \"surcharge_fee_amount\": 0,\n \"merchant_fee_amount\": 0,\n \"tax_amount\": 0,\n \"tip_fee_amount\": 0,\n \"tax_fee_amount\": 0,\n \"city_tax_amount\": 0,\n \"state_tax_amount\": 5,\n \"original_amount\": 0,\n \"tran_no\": 1,\n \"stan_no\": \"214\",\n \"invoice_no\": \"1\",\n \"batch_no\": \"151\",\n \"pos_entry_mode\": \"012\",\n \"masked_card_no\": \"4111 XXXX XXXX 1111\",\n \"card_scheme\": \"Visa\",\n \"request_date\": \"10-13-2023\",\n \"request_time\": \"01:39 AM\",\n \"store_time_zone\": \"EST\",\n \"mid\": \"887000003190\",\n \"tid\": \"00000013\",\n \"rrn\": \"328605500127\",\n \"approval_code\": \"TAS632\",\n \"card_menu_selection\": \"1\",\n \"response_code\": \"00\",\n \"switch_response_code\": \"00\",\n \"settlement_mode\": null,\n \"settled_at\": \"2023-10-13T05:39:51.000Z\",\n \"batches_id\": null,\n \"surver_answer\": 1,\n \"additional_doc1\": null,\n \"is_voided\": 0,\n \"is_auth_completed\": 0,\n \"created_at\": \"2023-10-13T05:39:51.000Z\",\n \"txamount\": 108,\n \"surcharge_label\": \"Non-Cash Charge\"\n }\n ],\n \"epiInfo\": {\n \"tip_adjust\": true,\n \"max_tip\": \"350\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "SUCCESS" }, "statusMsg": { "type": "string", "example": "Open batch request success" }, "batchSummary": { "type": "array", "items": { "type": "object", "properties": { "dashboard_netamount": { "type": "integer", "example": 1298, "default": 0 }, "dashboard_batchcount": { "type": "integer", "example": 3, "default": 0 } } } }, "batchSummaryDetails": { "type": "array", "items": { "type": "object", "properties": { "tip_adjusted_count": { "type": "integer", "example": 0, "default": 0 }, "txn_id": { "type": "integer", "example": 5221108, "default": 0 }, "invoice_mode": { }, "epi_id": { "type": "string", "example": "2235451562" }, "message_type": { "type": "string", "example": "0200" }, "processing_code": { "type": "string", "example": "000000" }, "txn_type": { "type": "string", "example": "SALE" }, "txn_type_code": { "type": "integer", "example": 101, "default": 0 }, "amount": { "type": "integer", "example": 100, "default": 0 }, "tip_amount": { "type": "integer", "example": 0, "default": 0 }, "cashback_amount": { "type": "integer", "example": 0, "default": 0 }, "custom_fee_amount": { "type": "integer", "example": 3, "default": 0 }, "isnew_txn": { "type": "integer", "example": 0, "default": 0 }, "surcharge_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "merchant_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "tax_amount": { "type": "integer", "example": 0, "default": 0 }, "tip_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "tax_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "city_tax_amount": { "type": "integer", "example": 0, "default": 0 }, "state_tax_amount": { "type": "integer", "example": 5, "default": 0 }, "original_amount": { "type": "integer", "example": 0, "default": 0 }, "tran_no": { "type": "integer", "example": 3, "default": 0 }, "stan_no": { "type": "string", "example": "312" }, "invoice_no": { "type": "string", "example": "3" }, "batch_no": { "type": "string", "example": "151" }, "pos_entry_mode": { "type": "string", "example": "012" }, "masked_card_no": { "type": "string", "example": "4386 XXXX XXXX 8273" }, "card_scheme": { "type": "string", "example": "Visa" }, "request_date": { "type": "string", "example": "10-13-2023" }, "request_time": { "type": "string", "example": "03:38 AM" }, "store_time_zone": { "type": "string", "example": "EST" }, "mid": { "type": "string", "example": "887000003190" }, "tid": { "type": "string", "example": "00000013" }, "rrn": { "type": "string", "example": "328607753675" }, "approval_code": { "type": "string", "example": "TAS725" }, "card_menu_selection": { "type": "string", "example": "1" }, "response_code": { "type": "string", "example": "00" }, "switch_response_code": { "type": "string", "example": "00" }, "settlement_mode": { }, "settled_at": { "type": "string", "example": "2023-10-13T07:38:01.000Z" }, "batches_id": { }, "surver_answer": { "type": "integer", "example": 2, "default": 0 }, "additional_doc1": { }, "is_voided": { "type": "integer", "example": 0, "default": 0 }, "is_auth_completed": { "type": "integer", "example": 0, "default": 0 }, "created_at": { "type": "string", "example": "2023-10-13T07:38:01.000Z" }, "txamount": { "type": "integer", "example": 108, "default": 0 }, "surcharge_label": { "type": "string", "example": "Non-Cash Charge" } } } }, "epiInfo": { "type": "object", "properties": { "tip_adjust": { "type": "boolean", "example": true, "default": true }, "max_tip": { "type": "string", "example": "350" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E04\",\n \"mesg\": \"PROCESSING ERROR\",\n \"msg\": \"PROCESSING ERROR\",\n \"desc\": \"INVALID MESSAGE CODE\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E04" }, "mesg": { "type": "string", "example": "PROCESSING ERROR" }, "msg": { "type": "string", "example": "PROCESSING ERROR" }, "desc": { "type": "string", "example": "INVALID MESSAGE CODE" } } } } } } }, "deprecated": false } }, "/?issuerefund": { "post": { "summary": "Issue Refund API", "description": "", "operationId": "issue-refund-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "amount", "in": "query", "description": "Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)", "required": true, "schema": { "type": "string", "default": "100" } }, { "name": "mtype", "in": "query", "description": "Set the message type as 'refund'", "required": true, "schema": { "type": "string", "default": "refund" } }, { "name": "rrn", "in": "query", "description": "RRN number from sale txn response (Numeric - Max length of 15 chars)", "required": true, "schema": { "type": "string" } }, { "name": "ref_txn_id", "in": "query", "description": "Reference transaction id for sale", "required": true, "schema": { "type": "string" } }, { "name": "stan", "in": "query", "description": "STAN number (Numeric - Max length of 6 chars)", "required": true, "schema": { "type": "string" } }, { "name": "tran_no", "in": "query", "description": "Should match the original sale tran_no (Numeric - Max length of chars 11)", "required": true, "schema": { "type": "string" } }, { "name": "auth_code", "in": "query", "description": "Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)", "required": true, "schema": { "type": "string" } }, { "name": "sale_refund", "in": "query", "description": "Sale refund set us value 1", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pos_entry_mode", "in": "query", "description": "Mode of transaction (length of 3 chars)", "required": true, "schema": { "type": "string", "default": "012" } }, { "name": "binType", "in": "query", "description": "To identify the card type check Credit or Debit", "schema": { "type": "string", "default": "1" } }, { "name": "userid", "in": "query", "description": "It is the userid of the merchant to be updated", "schema": { "type": "string" } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Customer user name (Alphanumeric length of 25 chars)", "schema": { "type": "string", "default": "Jackson" } }, { "name": "card_holder_name", "in": "query", "description": "Shipping address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "surchargeRemoved", "in": "query", "description": "To remove the surcharge fee set value 0 else set 1", "schema": { "type": "string", "default": "0" } }, { "name": "pos_condition_code", "in": "query", "description": "Check the condition of transaction (length of max 3 chars)", "schema": { "type": "string", "default": "08" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"error_code\": \"00\",\n \"amount\": \"110.00\",\n \"msg\": \"APPROVED\",\n \"desc\": \"APPROVAL TAS890 \",\n \"additional_info\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\",\n \"rrn\": \"328911501903\",\n \"txnid\": \"5228218\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "110.00" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": "APPROVAL TAS890 " }, "additional_info": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" }, "rrn": { "type": "string", "example": "328911501903" }, "txnid": { "type": "string", "example": "5228218" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E98\",\n \"error_code\": \"12\",\n \"success_url\": false,\n \"txnid\": \"5228066\",\n \"switch_error_code\": \"V0543\",\n \"mesg\": \"Original transaction not found\",\n \"desc\": \"Error code :12\",\n \"msg\": \"Original transaction not found\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E98" }, "error_code": { "type": "string", "example": "12" }, "success_url": { "type": "boolean", "example": false, "default": true }, "txnid": { "type": "string", "example": "5228066" }, "switch_error_code": { "type": "string", "example": "V0543" }, "mesg": { "type": "string", "example": "Original transaction not found" }, "desc": { "type": "string", "example": "Error code :12" }, "msg": { "type": "string", "example": "Original transaction not found" } } } } } } }, "deprecated": false } }, "/refundapi?direct": { "post": { "summary": "Refund API", "description": "", "operationId": "refund-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "epi", "in": "query", "description": "The unique id refers to a particular store of the merchant", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "mtype", "in": "query", "description": "Set the message type as 'refund'", "required": true, "schema": { "type": "string", "default": "refund" } }, { "name": "amount", "in": "query", "description": "Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)", "required": true, "schema": { "type": "number", "format": "double", "default": 100 } }, { "name": "pan", "in": "query", "description": "Customer card number 15 to 19 digits", "required": true, "schema": { "type": "string", "default": "4111111111111111" } }, { "name": "expiry_date", "in": "query", "description": "Card expiry date, Accepted expiry MMYY & MM/YY", "required": true, "schema": { "type": "string", "default": "1225" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "food_amount", "in": "query", "description": "Currency $(Eg. 00.00) - Food amount should be less than to transaction amount", "schema": { "type": "number", "format": "double" } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double" } }, { "name": "city_tax", "in": "query", "description": "City tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "reduced_tax", "in": "query", "description": "Reduced tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "number", "format": "double", "default": 0 } }, { "name": "uid", "in": "query", "description": "A unique id of the request, A client can send any number of 10 digit", "schema": { "type": "string" } }, { "name": "custom_fee", "in": "query", "description": "Additional fee of surcharge amount - Currency $ (Eg: 10.00)", "schema": { "type": "number", "format": "double" } }, { "name": "cvv", "in": "query", "description": "Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)", "schema": { "type": "string", "default": "999" } }, { "name": "binType", "in": "query", "description": "To identify the card type to check Credit or Debit", "schema": { "type": "string", "default": "1" } }, { "name": "surchargeRemoved", "in": "query", "description": "To remove the surcharge fee set value 0 else set 1", "schema": { "type": "string", "default": "0" } }, { "name": "card_holder_name", "in": "query", "description": "Name of the cardholder - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_customerName", "in": "query", "description": "Shipping address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "b_customerName", "in": "query", "description": "Billing address customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string" } }, { "name": "recursivePaymentId", "in": "query", "description": "Customer unique recursive payment id (subscription id) (Numeric - Max length of 11 chars)", "schema": { "type": "string" } }, { "name": "avs", "in": "query", "description": "Address verification service (zip, street address - Numeric length of one chars)", "schema": { "type": "string", "default": "1" } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Customer user name (Alphanumeric length of 25 chars)", "schema": { "type": "string" } }, { "name": "s_street_no", "in": "query", "description": "Shipping address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string", "default": "2nd Avenue" } }, { "name": "s_street_name", "in": "query", "description": "Shipping address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "s_unit", "in": "query", "description": "Shipping address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "s_city", "in": "query", "description": "Shipping address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "s_state", "in": "query", "description": "Shipping address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "s_zip", "in": "query", "description": "Shipping address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string" } }, { "name": "b_street_no", "in": "query", "description": "Billing address street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string", "default": "123 Avenue" } }, { "name": "b_street_name", "in": "query", "description": "Billing address street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string" } }, { "name": "b_unit", "in": "query", "description": "Billing address unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string" } }, { "name": "b_city", "in": "query", "description": "Billing address city should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string" } }, { "name": "b_state", "in": "query", "description": "Billing address state 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string" } }, { "name": "b_zip", "in": "query", "description": "Billing address zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string" } }, { "name": "orderId", "in": "query", "description": "Transaction order id for sale and auth (Length of max 11 chars)", "schema": { "type": "string" } }, { "name": "invoicenumber", "in": "query", "description": "Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)", "schema": { "type": "string" } }, { "name": "dataset_id", "in": "query", "description": "Line item against created dataset id (Numeric -Max length of 20 chars, Ex: 364, 370 )", "schema": { "type": "string", "default": "0" } }, { "name": "orderdescription", "in": "query", "description": "Add the order description - Optional (Alphanumeric - Max length of 50 chars)", "schema": { "type": "string" } }, { "name": "validateCard", "in": "query", "description": "Validate the card default set as 1", "schema": { "type": "string", "default": "0" } }, { "name": "userid", "in": "query", "description": "It is the userid of the merchant to be updated", "schema": { "type": "string" } }, { "name": "uuid", "in": "query", "description": "2FA request uuid (Max length of 50 chars)", "required": true, "schema": { "type": "string" } }, { "name": "otp", "in": "query", "description": "Direct refund OTP (Ex: 500654, Max length of 6 chars)", "required": true, "schema": { "type": "string" } }, { "name": "otp_app_id", "in": "query", "description": "Refund OTP API key", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "otp_api_key", "in": "query", "description": "Refund OTP APP Id", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"error_code\": \"00\",\n \"amount\": \"100.00\",\n \"msg\": \"APPROVED\",\n \"desc\": \" NO MATCH \",\n \"additional_info\": null,\n \"epi\": \"2319914861\",\n \"channel\": \"VT\",\n \"rrn\": \"328911501243\",\n \"txnid\": \"5227750\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "100.00" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { "type": "string", "example": " NO MATCH " }, "additional_info": { }, "epi": { "type": "string", "example": "2319914861" }, "channel": { "type": "string", "example": "VT" }, "rrn": { "type": "string", "example": "328911501243" }, "txnid": { "type": "string", "example": "5227750" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E07\",\n \"mesg\": \"TRANSACTION NOT ALLOWED\",\n \"msg\": \"TRANSACTION NOT ALLOWED\",\n \"desc\": \"Invalid one time password(OTP)\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E07" }, "mesg": { "type": "string", "example": "TRANSACTION NOT ALLOWED" }, "msg": { "type": "string", "example": "TRANSACTION NOT ALLOWED" }, "desc": { "type": "string", "example": "Invalid one time password(OTP)" } } } } } } }, "deprecated": false } }, "/?closedbatch": { "post": { "summary": "Closed Batch API", "description": "", "operationId": "closed-batch-api", "parameters": [ { "name": "batchID", "in": "query", "description": "Batch Id for Merchant (Numeric - Ex: 33876)", "schema": { "type": "string" } }, { "name": "batchNO", "in": "query", "description": "Batch number of the open batch details (Numeric - Ex: 54876)", "required": true, "schema": { "type": "string", "default": "39" } }, { "name": "mtype", "in": "query", "description": "Set the message type as 'getclosebatch'", "required": true, "schema": { "type": "string", "default": "getclosebatch" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2319914786" } }, { "name": "limit", "in": "query", "description": "Limit for pagnation. Max 50 and default as 0", "required": true, "schema": { "type": "string", "default": "20" } }, { "name": "offset", "in": "query", "description": "Offset for pagination. Default as 0", "required": true, "schema": { "type": "string", "default": "0" } }, { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "ZLC6pTITTJ4MlTAo2DpnPlEZwttgm4vp" } }, { "name": "appkey", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "xtG5iGg0SHVGhXHI30Hz5VKG2bolU5Mq" } }, { "name": "auth_token", "in": "query", "description": "Authentication Token is a piece of information that verifies the identity of a user to a website (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "f8ec0e50-6831-11ee-b69e-07ff5d348884" } }, { "name": "storeid", "in": "query", "description": "Merchant store Id (Max length of chars 11)", "required": true, "schema": { "type": "integer", "format": "int32", "default": 17358 } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"SUCCESS\",\n \"statusMsg\": \"Closed batch transaction details\",\n \"transactionCount\": 1,\n \"closedBatchDetails\": [\n {\n \"txn_id\": 5337551,\n \"epi_id\": \"2319914861\",\n \"message_type\": \"0200\",\n \"processing_code\": \"000000\",\n \"txn_type\": \"SALE\",\n \"txn_type_code\": 101,\n \"amount\": 1000,\n \"tip_amount\": 0,\n \"cashback_amount\": 0,\n \"custom_fee_amount\": 30,\n \"surcharge_fee_amount\": 0,\n \"merchant_fee_amount\": 0,\n \"tax_amount\": 0,\n \"city_tax_amount\": 0,\n \"state_tax_amount\": 0,\n \"original_amount\": 0,\n \"tran_no\": 1,\n \"stan_no\": \"826\",\n \"invoice_no\": \"1\",\n \"batch_no\": \"51\",\n \"pos_entry_mode\": \"012\",\n \"masked_card_no\": \"4111 XXXX XXXX 1111\",\n \"card_scheme\": \"Visa\",\n \"request_date\": \"2023-10-25T00:00:00.000Z\",\n \"request_time\": \"02:26:26\",\n \"mid\": \"887000003193\",\n \"tid\": \"75021674\",\n \"rrn\": \"329806501505\",\n \"approval_code\": \"TAS124\",\n \"response_code\": \"00\",\n \"switch_response_code\": \"00\",\n \"settlement_mode\": null,\n \"settled_at\": \"2023-10-25T06:26:26.000Z\",\n \"batches_id\": null,\n \"card_menu_selection\": \"1\",\n \"surver_answer\": null,\n \"additional_doc1\": null,\n \"created_at\": \"2023-10-25T06:26:26.000Z\",\n \"txamount\": 1030,\n \"is_voided\": 0,\n \"is_auth_completed\": 0,\n \"tip_fee_amount\": 0,\n \"tax_fee_amount\": 0\n }\n ]\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "SUCCESS" }, "statusMsg": { "type": "string", "example": "Closed batch transaction details" }, "transactionCount": { "type": "integer", "example": 1, "default": 0 }, "closedBatchDetails": { "type": "array", "items": { "type": "object", "properties": { "txn_id": { "type": "integer", "example": 5337551, "default": 0 }, "epi_id": { "type": "string", "example": "2319914861" }, "message_type": { "type": "string", "example": "0200" }, "processing_code": { "type": "string", "example": "000000" }, "txn_type": { "type": "string", "example": "SALE" }, "txn_type_code": { "type": "integer", "example": 101, "default": 0 }, "amount": { "type": "integer", "example": 1000, "default": 0 }, "tip_amount": { "type": "integer", "example": 0, "default": 0 }, "cashback_amount": { "type": "integer", "example": 0, "default": 0 }, "custom_fee_amount": { "type": "integer", "example": 30, "default": 0 }, "surcharge_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "merchant_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "tax_amount": { "type": "integer", "example": 0, "default": 0 }, "city_tax_amount": { "type": "integer", "example": 0, "default": 0 }, "state_tax_amount": { "type": "integer", "example": 0, "default": 0 }, "original_amount": { "type": "integer", "example": 0, "default": 0 }, "tran_no": { "type": "integer", "example": 1, "default": 0 }, "stan_no": { "type": "string", "example": "826" }, "invoice_no": { "type": "string", "example": "1" }, "batch_no": { "type": "string", "example": "51" }, "pos_entry_mode": { "type": "string", "example": "012" }, "masked_card_no": { "type": "string", "example": "4111 XXXX XXXX 1111" }, "card_scheme": { "type": "string", "example": "Visa" }, "request_date": { "type": "string", "example": "2023-10-25T00:00:00.000Z" }, "request_time": { "type": "string", "example": "02:26:26" }, "mid": { "type": "string", "example": "887000003193" }, "tid": { "type": "string", "example": "75021674" }, "rrn": { "type": "string", "example": "329806501505" }, "approval_code": { "type": "string", "example": "TAS124" }, "response_code": { "type": "string", "example": "00" }, "switch_response_code": { "type": "string", "example": "00" }, "settlement_mode": { }, "settled_at": { "type": "string", "example": "2023-10-25T06:26:26.000Z" }, "batches_id": { }, "card_menu_selection": { "type": "string", "example": "1" }, "surver_answer": { }, "additional_doc1": { }, "created_at": { "type": "string", "example": "2023-10-25T06:26:26.000Z" }, "txamount": { "type": "integer", "example": 1030, "default": 0 }, "is_voided": { "type": "integer", "example": 0, "default": 0 }, "is_auth_completed": { "type": "integer", "example": 0, "default": 0 }, "tip_fee_amount": { "type": "integer", "example": 0, "default": 0 }, "tax_fee_amount": { "type": "integer", "example": 0, "default": 0 } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": \"SUCCESS\",\n \"statusMsg\": \"No Transaction Found\",\n \"transactionCount\": 0,\n \"closedBatchDetails\": []\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "SUCCESS" }, "statusMsg": { "type": "string", "example": "No Transaction Found" }, "transactionCount": { "type": "integer", "example": 0, "default": 0 }, "closedBatchDetails": { "type": "array" } } } } } } }, "deprecated": false } }, "/?tipadjust": { "post": { "summary": "TIP Adjustment", "description": "", "operationId": "tip-adjustment", "parameters": [ { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2313185814" } }, { "name": "amount", "in": "query", "description": "TIP amount - $(Ex: 5.00, 10.00, 20.00 etc.)", "required": true, "schema": { "type": "number", "format": "double", "default": 5 } }, { "name": "stan", "in": "query", "description": "STAN number (Numeric - Max length of 6 chars)", "required": true, "schema": { "type": "string" } }, { "name": "rrn", "in": "query", "description": "RRN number from sale txn response (Numeric - Max length of 15 chars)", "required": true, "schema": { "type": "string" } }, { "name": "auth_code", "in": "query", "description": "Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)", "required": true, "schema": { "type": "string" } }, { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "464DA39FCFB44D54F6C1D22CEF9098E5" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "15B8BCFDB337428792608354A1444050" } }, { "name": "auth_token", "in": "query", "description": "Authentication Token is a piece of information that verifies the identity of a user to a website (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "8E1DDE8DE369812732E88C583B14D0C4" } }, { "name": "mtype", "in": "query", "description": "Transaction type should be set as 'tipadjust'", "required": true, "schema": { "type": "string", "default": "tipadjust" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"success_url\": true,\n \"error_code\": \"00\",\n \"amount\": \"5.00\",\n \"tax\": \"\",\n \"customfee\": \"\",\n \"msg\": \"APPROVED\",\n \"desc\": null,\n \"additional_info\": null,\n \"clerk_id\": null,\n \"clerk_name\": null,\n \"clerk_label\": null,\n \"additionalKeyOne\": null,\n \"additionalKeyTwo\": null,\n \"additionalValueOne\": null,\n \"additionalValueTwo\": null,\n \"approval_code\": \"TAS070\",\n \"rrn\": \"330310752470\",\n \"txnid\": null,\n \"tran_no\": 6,\n \"stan\": 595,\n \"is_partial_approve\": 0,\n \"partial_amount\": \"000000000500\",\n \"pan\": \"XXXX\",\n \"card_type\": null,\n \"phone_number\": null,\n \"email_id\": null,\n \"zip\": null,\n \"card_holder_name\": null,\n \"expiry_date\": \"/\",\n \"address\": null,\n \"epi\": \"2313185814\",\n \"channel\": \"VT\",\n \"token\": null,\n \"card_brand\": null,\n \"netamt\": 5\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "success_url": { "type": "boolean", "example": true, "default": true }, "error_code": { "type": "string", "example": "00" }, "amount": { "type": "string", "example": "5.00" }, "tax": { "type": "string", "example": "" }, "customfee": { "type": "string", "example": "" }, "msg": { "type": "string", "example": "APPROVED" }, "desc": { }, "additional_info": { }, "clerk_id": { }, "clerk_name": { }, "clerk_label": { }, "additionalKeyOne": { }, "additionalKeyTwo": { }, "additionalValueOne": { }, "additionalValueTwo": { }, "approval_code": { "type": "string", "example": "TAS070" }, "rrn": { "type": "string", "example": "330310752470" }, "txnid": { }, "tran_no": { "type": "integer", "example": 6, "default": 0 }, "stan": { "type": "integer", "example": 595, "default": 0 }, "is_partial_approve": { "type": "integer", "example": 0, "default": 0 }, "partial_amount": { "type": "string", "example": "000000000500" }, "pan": { "type": "string", "example": "XXXX" }, "card_type": { }, "phone_number": { }, "email_id": { }, "zip": { }, "card_holder_name": { }, "expiry_date": { "type": "string", "example": "/" }, "address": { }, "epi": { "type": "string", "example": "2313185814" }, "channel": { "type": "string", "example": "VT" }, "token": { }, "card_brand": { }, "netamt": { "type": "integer", "example": 5, "default": 0 } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E98\",\n \"error_code\": \"VV\",\n \"success_url\": false,\n \"txnid\": null,\n \"switch_error_code\": \"V0547\",\n \"mesg\": \"More than 2 Tip adjust not allowed\",\n \"desc\": \"Error code :VV\",\n \"msg\": \"More than 2 Tip adjust not allowed\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E98" }, "error_code": { "type": "string", "example": "VV" }, "success_url": { "type": "boolean", "example": false, "default": true }, "txnid": { }, "switch_error_code": { "type": "string", "example": "V0547" }, "mesg": { "type": "string", "example": "More than 2 Tip adjust not allowed" }, "desc": { "type": "string", "example": "Error code :VV" }, "msg": { "type": "string", "example": "More than 2 Tip adjust not allowed" } } } } } } }, "deprecated": false } }, "/?addSubs": { "post": { "summary": "Add Subscription API", "description": "", "operationId": "add-subscription-api", "parameters": [ { "name": "app_id", "in": "query", "description": "Merchant APP ID (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "WaJeJErcv5xpqZa2UZz6LZod5MSyyfJw" } }, { "name": "auth_key", "in": "query", "description": "Merchant APP Key (Alphanumeric - Length of 32 chars)", "required": true, "schema": { "type": "string", "default": "53PWdki5U0PGSVhRnVoFsfVSbuDutsA8" } }, { "name": "amount", "in": "query", "description": "Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99)", "required": true, "schema": { "type": "number", "format": "double", "default": 100 } }, { "name": "custom_fee", "in": "query", "description": "Additional fee of surcharge amount - Currency $ (Eg: 10.00)", "required": true, "schema": { "type": "number", "format": "double", "default": 3 } }, { "name": "tax", "in": "query", "description": "Tax amount - Currency $ (Eg. 00.00)", "schema": { "type": "string", "default": "3.50" } }, { "name": "cvv", "in": "query", "description": "Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)", "schema": { "type": "string", "default": "999" } }, { "name": "mtype", "in": "query", "description": "Message type should be set as 'add_subscription'", "required": true, "schema": { "type": "string", "default": "add_subscription" } }, { "name": "epi", "in": "query", "description": "EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2", "required": true, "schema": { "type": "string", "default": "2203082193" } }, { "name": "pan", "in": "query", "description": "Customer card number 15 to 19 digits", "required": true, "schema": { "type": "string", "default": "4111111111111111" } }, { "name": "expiry_date", "in": "query", "description": "Card expiry date, Accepted expiry MMYY & MM/YY", "required": true, "schema": { "type": "string", "default": "0229" } }, { "name": "surchargeIndicator", "in": "query", "description": "The value '0' represents a transaction being ran on the traditional MID with no custom fee added, while '1' represents a transaction being ran on the cash discounting MID with the custom fee added", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "recurring_type", "in": "query", "description": "To accepts 0-Weekley or 1-Bi-Weekly or 2-Monthly", "required": true, "schema": { "type": "string", "default": "2" } }, { "name": "is_validate_card", "in": "query", "description": "Either 0 or 1", "required": true, "schema": { "type": "string", "default": "1" } }, { "name": "card_holder_name", "in": "query", "description": "Name of the cardholder - Alphabet (Max length of 25 chars)", "schema": { "type": "string", "default": "John Doe" } }, { "name": "descriptor", "in": "query", "description": "It should be 25 chars", "schema": { "type": "string", "default": "TEST DESCRIPTOR" } }, { "name": "product_description", "in": "query", "description": "Description of the product max 50 chars", "schema": { "type": "string", "default": "Product 1" } }, { "name": "invoice_no", "in": "query", "description": "Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)", "schema": { "type": "string", "default": "12345678" } }, { "name": "shipping_street_no", "in": "query", "description": "Street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string", "default": "3636" } }, { "name": "shipping_street_name", "in": "query", "description": "Street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string", "default": "33rd street" } }, { "name": "shipping_customer_name", "in": "query", "description": "Shipping customer name - Alphabet (Max length of 25 chars)", "schema": { "type": "string", "default": "John Doe" } }, { "name": "shipping_unit", "in": "query", "description": "Street unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string", "default": "206" } }, { "name": "shipping_zip", "in": "query", "description": "Zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string", "default": "11106" } }, { "name": "shipping_city", "in": "query", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string", "default": "ASTORIA" } }, { "name": "billing_customer_name", "in": "query", "description": "Customer Name - Alphabet (Max length of max 25 chars)", "schema": { "type": "string", "default": "John Doe" } }, { "name": "shipping_state", "in": "query", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string", "default": "NY" } }, { "name": "billing_street_no", "in": "query", "description": "Street number - Number with hyphen (Ex: 1-95)", "schema": { "type": "string", "default": "3636" } }, { "name": "billing_unit", "in": "query", "description": "Street unit (Ex. block, apartment) - Max length of 25 chars", "schema": { "type": "string", "default": "206" } }, { "name": "billing_street_name", "in": "query", "description": "Street name - Alphanumeric (Length of 50 chars)", "schema": { "type": "string", "default": "33rd street" } }, { "name": "billing_zip", "in": "query", "description": "Zip code should be 5 digits (Numeric - Ex: 10001, 90002)", "schema": { "type": "string", "default": "11106" } }, { "name": "billing_city", "in": "query", "description": "City should be allowed max 50 chars of string (Ex: New York, San Francisco)", "schema": { "type": "string", "default": "ASTORIA" } }, { "name": "billing_state", "in": "query", "description": "State 2 chars of capital (Ex: New York - NY, California - CA)", "schema": { "type": "string", "default": "NY" } }, { "name": "subscription_starts_from", "in": "query", "description": "Subscription start payment date accepted expiry YYYYMMDD", "required": true, "schema": { "type": "string", "default": "2025-12-25" } }, { "name": "phone", "in": "query", "description": "Customer phone number- 10 digit Numeric (Ex: 5247896523)", "schema": { "type": "string", "default": "5478964785" } }, { "name": "email", "in": "query", "description": "Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)", "schema": { "type": "string", "default": "jhonsmith@valorpaytech.com" } }, { "name": "charge_until", "in": "query", "description": "Months or Week based on recurring_type. If never expire to pass \"never_expired\"", "schema": { "type": "string", "default": "6" } }, { "name": "charge_on", "in": "query", "description": "If recurring type 0-Weekley or 1-Bi-Weekly this should be any value from 0 to 6 else if recurring type 2-Monthly it accept any value from 1 to 30 Days in month", "schema": { "type": "string", "default": "25" } }, { "name": "failure_notification", "in": "query", "description": "Failure Notification set as 0 or 1", "schema": { "type": "string", "default": "1" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"S00\",\n \"error_code\": \"00\",\n \"subscription_id\": 15498,\n \"msg\": \"SUBSRIPTION_CREATED\",\n \"desc\": \"Subsription has been created\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "S00" }, "error_code": { "type": "string", "example": "00" }, "subscription_id": { "type": "integer", "example": 15498, "default": 0 }, "msg": { "type": "string", "example": "SUBSRIPTION_CREATED" }, "desc": { "type": "string", "example": "Subsription has been created" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"error_no\": \"E26\",\n \"mesg\": \"PROCESSING ERROR\",\n \"msg\": \"PROCESSING ERROR\",\n \"desc\": \"AUTHENTICATION FAILED\"\n}" } }, "schema": { "type": "object", "properties": { "error_no": { "type": "string", "example": "E26" }, "mesg": { "type": "string", "example": "PROCESSING ERROR" }, "msg": { "type": "string", "example": "PROCESSING ERROR" }, "desc": { "type": "string", "example": "AUTHENTICATION FAILED" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true }