API Reference

Direct Refund API

post
https://securelink-staging.valorpaytech.com:443/?directRefund
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

2FA Authentication for Direct Refund

The Direct Refund API requires 2FA authentication. First, initiate a 2FA request to generate an OTP, which will be sent to the registered email address. Once the OTP is received, include the following parameters in the Direct Refund API request:

otp – OTP received via email.
otp_api_id – API ID used for 2FA authentication.
otp_app_key – APP key used for 2FA authentication.
uid – Unique user identifier associated with the 2FA request.

All four parameters, otp, otp_api_id, otp_app_key, and uid, must be provided in the Direct Refund API request to complete the 2FA validation and process the refund.

Body Params
string
required
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

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

string
required
Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

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

string
required
Defaults to 2412333540

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

string
required
Defaults to direct-refund

Txn type should be "direct-refund"

string
required
Defaults to 1

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

string

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

string

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

string

Name of the cardholder. Must contain alphabetic characters only and have a maximum length of 40 characters.

string
required
Defaults to 4111111111111111

Customer card number. Must contain 15 to 19 digits.

string
required
Defaults to 1236

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

string
required
Defaults to 999

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

string

Customer email id - Varchar (Ex: [email protected], Max length of 50 chars)

string

The descriptor must not exceed 30 characters.

string

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

string

Invoice number field must contain a maximum of 12 characters and may include only alphanumeric characters. < and > are not allowed.

string
Defaults to 0

Set this value to 1 if the transaction should be synced with QuickBooks. Otherwise, set it to 0.

string
required
Defaults to 1

Set 0 for transactions processed through a traditional MID with no custom fee. Set 1 for transactions processed through a cash discounting MID with a custom fee.

string

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

string

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

string

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

string
required

2FA request uuid (Max length of 50 chars)

string
required

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

string
required
Defaults to h6tSvf0Cz7fSB86B44bkLEplS15AsWYo

Refund OTP APP Id

string
required
Defaults to zOKj0LUOiW4L9jFRrMbMiJQ5KxQEpSMm

Refund OTP APP Key

additional_prompts
array of objects

Custom inputs, with a maximum of 25 entries allowed.

additional_prompts
string
Defaults to 0

If the priority processor, set the value to 1 to save the card to the processor; otherwise, set it to 0.

Responses

Updated 1 day ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?