v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Sale API

post/?giftSale

Request body

appidstring required

Merchant APP ID (Alphanumeric - Length of 32 chars and special chars $@%#)

appkeystring required

Merchant APP KEY (Alphanumeric - Length of 32 chars and special chars $@%#)

epistring required

EPI is an end point identifier, Identify the device on valor infrastructure, it's a 10 digit number starts with 2

txn_typestring required

Transaction type always should be set as 'giftsale'

amountnumber double required

Base amount of original sale (Ex: 10.00). A request should not be sent when the amount is 0. The amount must be greater than zero

card_nostring required

Customer gift card number 15 to 19 digits

pininteger

Customer gift card pin number

emailstring required

Customer email id - Varchar (Ex: test@domain.com, Max length of 50 chars)

phonestring

Customer phone number- 10 digit Numeric (Ex: 5247896523)

cardholdernamestring

Name of the cardholder - Alphabet (Max length of 25 chars)

Response

200

error_nostring

success_urlboolean

error_codestring

amountstring

taxstring

customfeestring

msgstring

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:desc","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:additional_info","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:clerk_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:clerk_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:clerk_label","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:additionalKeyOne","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:additionalKeyTwo","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:additionalValueOne","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:additionalValueTwo","oasType":"schema","type":"unknown"}

approval_codestring

rrnstring

txnidstring

tran_nointeger

staninteger

is_partial_approveinteger

partial_amountstring

panstring

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:card_type","oasType":"schema","type":"unknown"}

phone_numberstring

email_idstring

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:zip","oasType":"schema","type":"unknown"}

card_holder_namestring

expiry_datestring

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:address","oasType":"schema","type":"unknown"}

epistring

channelstring

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:token","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/?giftSale:post:responses:200:content:application/json:schema:properties:card_brand","oasType":"schema","type":"unknown"}

netamtinteger

Example response

{
  "error_no": "S00",
  "success_url": true,
  "error_code": "00",
  "amount": "5.00",
  "msg": "APPROVED",
  "approval_code": "000000",
  "rrn": "004012058001",
  "txnid": "5846087",
  "tran_no": 1,
  "stan": 688,
  "partial_amount": "000000000500",
  "pan": "XXXX2926",
  "phone_number": "1234567890",
  "email_id": "test@domain.com",
  "card_holder_name": "Test",
  "expiry_date": "/",
  "epi": "2319916601",
  "channel": "VT",
  "netamt": 5
}