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 / Authorization
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
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
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
2FA Request API – OTP Generation
This API is used to initiate a two-factor authentication (2FA) request by generating a One-Time Password (OTP) for user verification. The OTP is securely generated and delivered to the user through the configured delivery channel, such as SMS, email, or authenticator service. The API validates the user identifier and 2FA configuration before generating the OTP. Once generated, the OTP is valid only for a limited time and can be used to complete authentication or authorize sensitive operations.
Typical Use Cases
- User login with two-factor authentication
- Verification before high-risk transactions
- Profile or payment method updates
- Account recovery and security validation
API Reference: 2FA Request API
Refund API – Direct Refund Using OTP
This API is used to initiate and process a direct refund transaction for a previously completed payment, secured through One-Time Password (OTP)–based two-factor authentication (2FA).
Before processing the refund, the API validates the refund request details (such as transaction reference and refund amount) and verifies the OTP provided by the user. This additional authentication layer ensures that only authorized users can perform sensitive refund operations.
Once OTP verification is successful, the refund is submitted to the payment processor. The API returns the refund status indicating whether the request was approved, declined, or failed, along with relevant reference details for tracking and reconciliation.
Typical Use Cases
- Refunds for high-risk or high-value transactions
- Secure refund processing after user login with two-factor authentication
- Refund authorization before sensitive financial operations
- Account and transaction security validation
API Reference: Refund API
List Subscription API
This API is used to retrieve a list of subscriptions configured for a merchant or customer. It returns subscription details such as subscription ID, status, billing frequency, amount, associated customer profile, and payment method.
The API supports filtering and pagination to efficiently manage large sets of subscription records and enables merchants to track and manage recurring payment agreements.
Typical Use Cases
- Viewing active and inactive subscriptions
- Subscription management dashboards
- Customer account subscription history
- Reconciliation and recurring billing audits