Direct Sale / Authorization
This API is used to initiate and process a card sale transaction through the Valor payment gateway. It securely submits card details, transaction amount, and merchant information to the payment processor for authorization and capture in a single request.
The API validates the card information (including CVV and AVS, when provided), applies any applicable surcharge, and attempts to charge the specified amount to the customer’s card. Based on the processor response, it returns the transaction result indicating whether the payment was approved, declined, or failed, along with relevant transaction details for tracking and reconciliation.
Typical Use Cases
- E-commerce checkout transactions
- Integrated merchant applications
API Reference: Direct Sale / Auth API
Direct Sale – Token
This API is used to process a card sale transaction using a previously generated payment token through the Valor payment gateway. Instead of sending raw card details, the API uses a secure token to reference the customer’s stored card information, improving security and PCI compliance.
The API submits the transaction amount, merchant identifiers, and optional order, tax, surcharge, and address details to the payment processor for authorization and capture in a single step. It supports e-commerce transactions by identifying the source channel and enables optional customer and merchant notifications via email or SMS.
Based on the processor’s response, the API returns the transaction status (approved, declined, or failed) along with relevant transaction details for confirmation, reporting, and reconciliation.
Typical Use Cases
- E-commerce payments
- Repeat or recurring transactions
- Vaulted card payments
API Reference: Direct Sale Token API
Direct Sale API (Level 2 & Level 3)
This API is used to process a Level 2 / Level 3 (L2/L3) card sale transaction through the Valor payment gateway. In addition to standard sale details, it allows merchants to submit enhanced transaction data, such as item-level order information, to support corporate, purchasing, and commercial card requirements.
The API securely sends card details, transaction amount, surcharge information, and detailed product line items (including item name, quantity, unit cost, and tax) to the payment processor for authorization and capture. Providing L2/L3 data helps improve interchange qualification, enhances transaction transparency, and supports detailed reporting and reconciliation.
Based on the processor response, the API returns the transaction status (approved, declined, or failed) along with transaction identifiers and response details.
Typical Use Cases
- B2B payments
- Commercial and corporate card transactions
- Item-level reporting requirements
API Reference : Direct Sale API (L2 & L3)
Direct Sale – Token (Level 2 & Level 3)
This API is used to process a Level 2 / Level 3 (L2/L3) card sale transaction using a secure payment token through the Valor payment gateway. Instead of transmitting raw card details, the API uses a previously generated token that represents the customer’s stored card information, enhancing security and PCI compliance.
The API submits the transaction amount, tax, surcharge details, merchant identifiers, and item-level order data (such as product name, quantity, unit cost, and tax) to the payment processor for authorization and capture in a single request. Supplying L2/L3 data helps improve interchange qualification and supports commercial and corporate card processing.
Based on the processor response, the API returns the transaction result indicating whether the payment was approved, declined, or failed, along with relevant transaction identifiers and response details.
Typical Use Cases
- B2B tokenized payments
- Vaulted card transactions
- Repeat and scheduled charges
- Enhanced e-commerce payments
API Reference: Direct Sale Token (L2 & L3)
Hosted Page Sale
This API is used to generate a secure hosted payment URL for initiating a sale transaction through the Valor payment gateway.
Instead of collecting or submitting card details directly, the API creates a secure payment link that can be shared with the customer via email or SMS.
When the customer clicks the generated URL, they are redirected to a Valor-hosted, PCI-compliant payment page where they can safely enter their payment details and complete the transaction. The gateway handles payment data collection, surcharge and tax calculation (unless explicitly ignored), and transaction processing.
Once the customer submits the payment, the gateway processes the sale and returns the transaction result, indicating whether the payment was approved, declined, or failed, along with the corresponding transaction details.
# Typical Use Cases
- Payment link–based checkout flows
- PCI-compliant payment collection without handling card data
- Email or SMS-based payment requests
- Secure hosted payment experiences
API Reference : Hosted Page Sale
Hosted Page Sale - Update and Resend
This API is used to update an existing hosted payment page sale transaction that was previously created through the Valor payment gateway. Using the unique transaction/session identifier (uid), merchants can modify transaction details before the payment is completed by the customer.
The API allows updates to the transaction amount, invoice details, order description, tax, surcharge configuration, discount information, customer details, and notification preferences. These updates ensure that the hosted payment page reflects the most accurate and up-to-date transaction information before payment submission.
Based on the update request, the gateway refreshes the hosted payment session and applies the changes accordingly. This endpoint is typically used when transaction details need to be adjusted after the initial page sale creation but prior to payment completion.
Typical Use Cases
- Updating amount, tax, or discount before payment
- Modifying invoice or order details
- Adjusting customer or notification settings on hosted pages
API Reference: Hosted Page Sale - Update and Resend
Hosted Page Sale - Cancel
This API is used to cancel an existing electronic invoice (eInvoice) created through the Valor payment gateway. By providing the unique invoice/session identifier (uid), the merchant can invalidate the eInvoice and prevent further payment attempts.
Once canceled, the eInvoice becomes inactive and can no longer be used for payment processing. This action is typically irreversible and is reflected immediately in the gateway.
This endpoint is commonly used when an invoice is no longer required, was created in error, or the transaction has been settled through an alternate payment method.
Typical Use Cases
- Canceling incorrectly generated invoices
- Preventing payment on expired or voided invoices
- Managing invoice lifecycle and cleanup
API Reference: Hosted Page Sale - Cancel
Merchant Hosted Page Sale
This API is used to submit payment details for a hosted payment page transaction through the Valor payment gateway. It completes the hosted page flow by securely capturing the customer’s card information and submitting it for transaction processing.
The API associates the provided card details with the existing hosted payment session using the unique identifier (uid). Once submitted, the gateway processes the payment for authorization and capture based on the previously configured transaction details.
Upon completion, the gateway returns the transaction result indicating whether the payment was approved, declined, or failed, along with relevant response and transaction details. This endpoint is typically invoked by the hosted payment page or integrated checkout flow.
Typical Use Cases
- Completing hosted page checkout flows
- Secure card data submission without merchant-side storage
- PCI-compliant payment processing
API Reference: Merchant Hosted Page Sale
Incremental Authorization
This API is used to increase the authorized amount of an existing transaction through the Valor payment gateway. It allows merchants to request an additional authorization on a previously approved transaction without initiating a new sale.
The API references the original transaction using the transaction identifier and submits the incremental amount to the payment processor for authorization. This is commonly used in scenarios where the final transaction amount is not known at the time of the initial authorization.
Based on the processor response, the API returns the authorization result indicating whether the incremental amount was approved or declined, along with updated authorization details.
Typical Use Cases
- Hospitality and lodging (tips, extended stays)
- Fuel, rental, and variable-amount transactions
- Adjusting authorized amounts after initial approval
API Reference: Incremental Auth
Refund Offset Sale
This API is used to refund a previously processed transaction through the Valor payment gateway. It allows merchants to return a full or partial amount to the customer’s original payment method.
The API submits the refund amount, invoice details, and refund configuration to the payment processor. Depending on the configuration, the refund can be linked directly to the original sale or processed as a standalone refund.
Based on the processor response, the API returns the refund status indicating whether the refund was approved, declined, or failed, along with relevant refund and transaction details.
Typical Use Cases
- Full or partial refunds
- Post-settlement transaction reversals
- Customer returns and cancellations
API Reference: Refund Offset Sale
Transaction Fetch (Advanced Filters)
This API is used to retrieve a list of transactions from the Valor payment gateway using advanced filtering options. It allows merchants to search transactions based on date, source, transaction type, card type, status, device, processor, and other criteria.
The API supports pagination through limit and offset parameters and can return both online and offline transactions. It is designed for efficient transaction lookup, reporting, and reconciliation.
Based on the request filters, the API returns a list of matching transactions along with detailed transaction metadata.
Typical Use Cases
- Transaction search and reporting
- Reconciliation and auditing
- Back-office and admin dashboards
API Reference: Transaction List API
Transaction List (Date Range)
This API is used to retrieve transactions within a specified date range through the Valor payment gateway. It allows merchants to fetch transactions based on start and end dates along with optional filters such as transaction type, card type, status, device, and processor.
The API supports pagination and versioned responses for optimized data retrieval. It is commonly used for generating daily, weekly, or monthly transaction reports.
Based on the request parameters, the API returns a list of transactions that match the specified date range and filter criteria.
Typical Use Cases
- Daily and monthly transaction reports
- Financial reconciliation
- Exporting transaction history
API Reference: Transaction List API (Date Range)
Void Transaction
This API is used to void a previously authorized or completed transaction before it is settled. Voiding a transaction prevents the funds from being captured and ensures the transaction does not appear in settlement.
The API references the original transaction using the transaction ID and submits the void request to the payment processor.
Typical Use Cases
- Canceling transactions created in error
- Voiding duplicate or incorrect charges
- Preventing settlement of unwanted transactions
API Reference:Void API
Settlement
This API is used to initiate settlement processing for transactions that have been authorized and captured. It submits eligible transactions for settlement with the processor.
Settlement finalizes the transaction and moves funds from the customer’s account to the merchant.
Typical Use Cases
- End-of-day settlement processing
- Manual settlement initiation
- Batch closing workflows
API Reference: Settlement API
Capture/Ticket API
This API is used to capture funds for a previously authorized transaction. It is commonly used in two-step payment flows where authorization and capture occur separately.
The API references the original authorization and captures the specified amount.
Typical Use Cases
- Delayed capture workflows
- Partial or full capture after authorization
- Order fulfillment–based payments
API Reference: Capture/Ticket API
Open Batch
This API is used to retrieve details of open batches for a merchant or device. Open batches contain transactions that are authorized or captured but not yet settled.
The API supports pagination for efficient batch data retrieval.
Typical Use Cases
- Monitoring open transaction batches
- End-of-day reconciliation
- Batch-level reporting
API Reference: Open Batch API
Closed Batch
This API is used to retrieve details of closed batches that have already been settled. It allows merchants to review batch summaries and transaction details for completed settlements.
The API supports pagination for historical batch review.
Typical Use Cases
- Reviewing settled batches
- Accounting and reconciliation
- Historical transaction analysis
API Reference: Closed Batch API
Tip Adjustment
This API is used to adjust the tip amount for a previously completed transaction. It updates the final transaction amount to include the adjusted tip before settlement.
Typical Use Cases
- Restaurant and hospitality tips
- Post-transaction gratuity updates
- Variable tip workflows
API Reference: TIP Adjust API
E-Receipt Fetch
This API is used to retrieve an electronic receipt (E-Receipt) for a specific transaction processed through the Valor payment gateway.
Merchants can fetch either a full receipt or a signature-only receipt using the transaction ID.
The API is commonly used to re-display receipts, send receipts to customers, or support post-transaction verification.
Based on the request parameters, the API returns receipt details associated with the provided transaction ID.
Typical Use Cases
- Fetching transaction receipts for customer reference
- Displaying receipts in merchant dashboards
- Re-sending receipts via email or SMS
- Retrieving signature-only receipts for compliance
API Reference: E-Receipt Fetch API
E-Invoice List
This API is used to retrieve a list of electronic invoices (E-Invoices) generated for transactions processed through the Valor payment gateway.
Merchants can fetch invoices using date-based filters along with pagination controls such as limit and offset.
The API supports structured retrieval of invoice records, making it suitable for reporting, auditing, and reconciliation purposes.
Based on the request parameters, the API returns a paginated list of E-Invoices that match the specified criteria.
Typical Use Cases
- Viewing and managing E-Invoices
- Financial reconciliation and auditing
- Exporting invoice data for reporting
- Tracking transaction invoices over a period
API Reference: Fetch E-Invoice API
BIN Lookup
This API is used to identify card details based on the BIN (Bank Identification Number). It returns information such as card type, brand, and issuing bank for the provided BIN.
This API does not perform a transaction and is informational only.
Typical Use Cases
- Card type detection
- Routing and risk analysis
- UI/UX enhancements during checkout
API Reference: BIN LookUp
Device Information
This API is used to retrieve device-related information associated with the merchant or EPI. It provides metadata useful for device monitoring and diagnostics.
Typical Use Cases
- Device status and diagnostics
- Terminal inventory management
- Support and troubleshooting
API Reference: Device Info
E-Receipt API
This API is used to send an electronic receipt for a completed transaction to the customer via email or SMS.
The receipt can be delivered using the transaction identifier and customer contact details.
Typical Use Cases
- Sending digital receipts
- Reducing paper receipts
- Customer transaction confirmation
API Reference: E-Receipt API
QR Code API
This API is used to initiate a QR code–based payment transaction through the Valor payment gateway. It generates a payment session that can be completed by scanning a QR code.
The API supports surcharge, tax, invoice, and customer details and is commonly used for contactless payment flows.
Typical Use Cases
- QR-based payments
- Contactless checkout experiences
- In-store and remote payments
API Reference: QR Code API
Modifier List
This API is used to retrieve a list of modifiers configured for a merchant in the Valor payment gateway.
It supports pagination using the limit parameter and is commonly used to display modifier data in merchant dashboards.
Typical Use Cases
- Viewing available modifiers
- Managing modifier configurations
API Reference: Get Modifier
Add Modifier
This API is used to create a new modifier for a merchant.
Modifiers can be associated with products to support customization options such as add-ons or variations.
Typical Use Cases
- Adding new product modifiers
API Reference: Create Modifier
Update Modifier
This API is used to update an existing modifier’s details, including name, pricing, inventory status, category, and activation state.
Typical Use Cases
- Editing modifier pricing or quantity
- Updating inventory or category details
API Reference: Update Modifier
Delete Modifier
This API is used to delete an existing modifier from the merchant account using the product ID.
Typical Use Cases
- Removing outdated or unused modifiers
- Cleaning up product configurations
API Reference: Delete Modifier
Discount List
This API is used to retrieve a list of discounts configured for a merchant.
It supports pagination and helps merchants manage available discount offers.
Typical Use Cases
- Viewing active discounts
- Managing promotional offers
API Reference: Get Discount
Create Discount
This API is used to create a new discount for a merchant.
Discounts can be configured as fixed-amount or percentage-based based on the amountType.
Typical Use Cases
- Creating promotional discounts
- Setting up seasonal or welcome offers
API Reference: Create Discount
Update Discount
This API is used to update an existing discount’s details, such as the discount name or calculation type.
Typical Use Cases
- Modifying discount rules
- Updating promotional details
API Reference: Update Discount
Delete Discount
This API is used to delete an existing discount using the discount ID.
Typical Use Cases
- Removing expired discounts
- Cleaning up inactive offers
API Reference: Delete Discount
Product List
This API is used to retrieve a list of products configured for a merchant.
It supports pagination and is commonly used to populate product catalogs in Portal systems.
Typical Use Cases
- Viewing product catalogs
- Syncing products to VT devices.
API Reference: Get Product
Create Product
This API is used to create a new product in the merchant’s inventory, including pricing, taxability, inventory tracking, and category details.
Typical Use Cases
- Adding new products
- Managing inventory items
API Reference: Create Product
Update Product
This API is used to update existing product details such as name, price, quantity, tax status, and category.
Typical Use Cases
- Updating product pricing
- Adjusting inventory levels
API Reference: Update Product
Delete Product
This API is used to delete an existing product from the merchant catalog using the product ID.
Typical Use Cases
- Removing discontinued products
- Cleaning up product listings
API Reference: Delete Product
Add Subscription
This API is used to create a new recurring subscription for a customer using the Valor payment gateway.
It supports card validation, surcharge handling, tax configuration, billing and shipping details, retry logic, and scheduled recurring charges.
Typical Use Cases
- Setting up recurring billing
- Subscription-based products or services
- Monthly or scheduled payments
API Reference: Add Subscription
Update Subscription
This API is used to update an existing subscription.
Merchants can modify billing amounts, tax, fees, card details, charge schedule, and notification preferences.
Typical Use Cases
- Updating subscription pricing
- Changing payment method
- Modifying recurring charge schedules
API Reference: Update Subscription API
Delete Subscription
This API is used to permanently delete a subscription using the subscription ID.
Once deleted, the subscription will no longer be billed.
Typical Use Cases
- Removing cancelled subscriptions
- Cleaning up inactive customer subscriptions
API Reference: Delete Subscription
Deactivate Subscription
This API is used to temporarily deactivate a subscription.
Deactivated subscriptions will not be charged until they are reactivated.
Typical Use Cases
- Pausing subscriptions
- Temporarily stopping recurring billing
API Reference: De-Activate Subscription
Activate Subscription
This API is used to reactivate a previously deactivated subscription, allowing recurring charges to resume based on the configured schedule.
Typical Use Cases
- Resuming paused subscriptions
- Restarting recurring billing
API Reference: Activate Subscription
ACH Void Transaction
This API is used to void a previously processed ACH transaction using the unique transaction identifier (UID).
It allows merchants to cancel an ACH transaction before it is fully settled.
Typical Use Cases
- Cancelling incorrect ACH transactions
- Reversing duplicate ACH payments
API Reference: Void API
ACH Sale
This API is used to process an ACH debit (sale) transaction directly from a customer’s bank account.
It supports business and personal accounts, tax fields, and routing/account validation.
Typical Use Cases
- Bank account debit payments
- Lower-cost alternative to card payments
- B2B and B2C ACH collections
API Reference: Sale API
ACH Recurring Sale
This API is used to create a recurring ACH payment subscription.
It allows merchants to schedule automated ACH debits with configurable frequency, start date, number of occurrences, and tax handling.
Typical Use Cases
- Monthly ACH subscriptions
- Installment-based payments
- Recurring utility or service billing
API Reference: ACH Recurring
ACH Transaction List (Date Range)
This API is used to retrieve a list of ACH transactions within a specified date range.
It supports pagination using limit and offset parameters for efficient data retrieval.
Typical Use Cases
- ACH transaction reporting
- Financial reconciliation
- Audit and compliance tracking
API Reference: ACH TxnFetch
ACH Recurring List
This API is used to fetch a list of recurring ACH subscriptions based on their status.
It supports pagination for managing large recurring datasets.
Typical Use Cases
- Viewing active or inactive ACH subscriptions
- Subscription monitoring and management
API Reference: ACH Recurring List
Delete ACH Recurring Subscription
This API is used to delete an existing ACH recurring subscription using the unique subscription UID.
Once deleted, no further ACH charges will be processed.
Typical Use Cases
- Cancelling recurring ACH billing
- Removing obsolete subscriptions
API Reference: ACH Recurring Delete
ACH Authorization Reminder
This API is used to send or trigger an ACH authorization reminder for a specific ACH transaction or recurring subscription.
It helps merchants comply with ACH authorization and consent requirements.
Typical Use Cases
- ACH authorization compliance
- Customer consent reminders
- Audit and regulatory purposes
API Reference: ACH Authorization
Gift Card Sale
This API is used to process a sale transaction using a gift card.
It deducts the specified amount from the gift card balance after validating the card number and PIN.
Typical Use Cases
- Accepting gift cards as a payment method
- In-store and e-commerce gift card redemptions
API Reference: Sale API
Gift Card Balance Inquiry
This API is used to retrieve the available balance of a gift card.
It validates the gift card number and PIN and returns the current balance and card status.
Typical Use Cases
- Checking remaining gift card balance
- Displaying balance before purchase
API Reference: Check Balance
Gift Card Activation
This API is used to activate a gift card before it can be used for transactions.
Once activated, the gift card becomes eligible for balance inquiry and sale transactions.
Typical Use Cases
- Activating newly issued gift cards
- Enabling gift cards at the time of sale
API Reference: Activate
Add Balance to Gift Card
This API is used to add value onto an existing gift card.
It increases the gift card balance by the specified amount after successful validation.
Typical Use Cases
- Reloading gift cards
- Adding promotional or bonus balances
- Customer-requested top-ups