v1

latestOpenAPI 3.1.02026-08-0425501.2 MB

Direct Refund API

post/?directRefund

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

Txn type should be "direct-refund"

amountstring required

Transaction amount - Maximum amount $99,999.99 (Ex: 0.1 to 99,999.99). A request should not be sent when the amount is 0. The amount must be greater than zero

customernamestring

Customer field must contain a maximum of 100 characters and may include only alphanumeric characters.

phonestring

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

card_holder_namestring

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

panstring required

Customer card number 15 to 19 digits

expiry_datestring required

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"))

cvvstring

Card Verification Value should be 3 or 4 digits (Ex: 999, 9997)

emailstring

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

descriptorstring
invoicenumberstring

Invoice number is a unique number assigned (Alphanumeric - Max length of 12 chars)

orderdescriptionstring

Add the order description - Optional (Alphanumeric - Max length of 50 chars)

qb_syncstring
surchargeIndicatorstring 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

s_street_nostring

Shipping address street number - Number with hyphen (Ex: 1-95)

b_street_nostring

Billing address street number - Number with hyphen (Ex: 1-95)

b_customerNamestring

Billing address customer name - Alphabet (Max length of 25 chars)

uuidstring required

2FA request uuid (Max length of 50 chars)

otpstring required

Direct refund OTP (Ex: 500654, Max length of 6 chars)

otp_app_idstring required

Refund OTP API Id

otp_api_keystring required

Refund OTP APP Key

Response

200

object required