v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Capture API

post/?captureapi

Query parameters

app_idstring required

Merchant APP ID (Alphanumeric - Length of 32 chars)

auth_keystring required

Merchant APP Key (Alphanumeric - Length of 32 chars)

mtypestring required

Transaction type should be set as 'capture'

epistring required

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

rrninteger required

RRN number from sale txn response (Numeric - Max length of 15 chars)

auth_codestring required

Approval code response from sale transaction (Alphanumeric - Max length of 8 chars)

staninteger required

STAN number (Numeric - Max length of 6 chars)

tran_nointeger required

Should match the original sale tran_no (Numeric - Max length of chars 11)

amountnumber double required

Add excess two zero for original capture transaction amount (Ex: 10.00 means 1000). A request should not be sent when the amount is 0. The amount must be greater than zero

pos_entry_modeinteger required

Mode of transaction in POS terminal

phoneinteger

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

uidinteger

A unique id of the request, A client can send any number of 10 digit

emailstring

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

surchargeIndicatorinteger required

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

taxnumber double

Tax amount - Currency $ (Eg. 00.00)

city_taxnumber double

City tax amount - Currency $ (Eg. 00.00)

custom_feenumber double

Custom fee/surcharge fee if any - Add excess two zero for original amount (ex: 5.00 means 500)

tip_amountnumber double

Tip if any - Optional (Eg. 00.00)

Request body

{"stackTrail":"paths:/?captureapi:post:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

error_nostring

success_urlboolean

error_codestring

amountstring

taxstring

customfeestring

msgstring

descstring

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

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

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

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

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

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

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

{"stackTrail":"paths:/?captureapi: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:/?captureapi:post:responses:200:content:application/json:schema:properties:card_type","oasType":"schema","type":"unknown"}

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

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

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

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

expiry_datestring

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

epistring

channelstring

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

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

netamtnumber

Example response

{
  "error_no": "S00",
  "success_url": true,
  "error_code": "00",
  "amount": "5.67",
  "tax": "0",
  "customfee": "14",
  "msg": "APPROVED",
  "desc": "APPROVAL TAS168 ",
  "approval_code": "TAS168",
  "rrn": "328510502516",
  "txnid": "5217748",
  "tran_no": 9,
  "stan": 105,
  "partial_amount": "000000000567",
  "pan": "XXXX",
  "expiry_date": "/",
  "epi": "2313185814",
  "channel": "VT",
  "netamt": 19.67
}