transbank-sdk/dist/es6/transbank/webpay/transaccion_completa/transaction.js

Transbank SDK for Node.js

import Options from '../../common/options';
import BaseTransaction from '../../common/base_transaction';
import { CaptureRequest, CommitRequest, CreateRequest, InstallmentsRequest, RefundRequest, StatusRequest } from './requests';
import RequestService from '../../common/request_service';
import Environment from '../common/environment';
import ValidationUtil from '../../common/validation_util';
import ApiConstants from '../../common/api_constants';
class Transaction extends BaseTransaction {
    /**
     * Constructor class transaction.
     * @param options You can pass options to use a custom configuration.
     */
    constructor(options) {
        super(options);
    }
    /**
     * Creates and returns an instance of `Transaction` configured for the integration environment.
     *
     * @param commerceCode The commerce code.
     * @param apiKey The API key used for authentication.
     * @return A new instance of `Transaction` configured for the test environment (Environment.Integration).
     */
    static buildForIntegration(commerceCode, apiKey) {
        return new Transaction(new Options(commerceCode, apiKey, Environment.Integration));
    }
    /**
     * Creates and returns an instance of `Transaction` configured for the production environment.
     *
     * @param commerceCode The commerce code.
     * @param apiKey The API key used for authentication.
     * @return A new instance of `Transaction` configured for the production environment (Environment.Production).
     */
    static buildForProduction(commerceCode, apiKey) {
        return new Transaction(new Options(commerceCode, apiKey, Environment.Production));
    }
    /**
     * Create a new Transaccion Completa transaction
     * @param buyOrder Commerce buy order, make sure this is unique.
     * @param sessionId You can use this field to pass session data if needed.
     * @param amount Transaction amount
     * @param cvv Card verification value
     * @param cardNumber Card's fron number
     * @param cardExpirationDate Card's expiration date
     */
    async create(buyOrder, sessionId, amount, cvv, cardNumber, cardExpirationDate) {
        ValidationUtil.hasTextWithMaxLength(buyOrder, ApiConstants.BUY_ORDER_LENGTH, "buyOrder");
        ValidationUtil.hasTextWithMaxLength(sessionId, ApiConstants.SESSION_ID_LENGTH, "sessionId");
        ValidationUtil.hasTextWithMaxLength(cardNumber, ApiConstants.CARD_NUMBER_LENGTH, "cardNumber");
        ValidationUtil.hasTextWithMaxLength(cardExpirationDate, ApiConstants.CARD_EXPIRATION_DATE_LENGTH, "cardExpirationDate");
        let createRequest = new CreateRequest(buyOrder, sessionId, amount, cvv, cardNumber.replace(/\s/g, ''), cardExpirationDate.replace(/\s/g, ''));
        return RequestService.perform(createRequest, this.options);
    }
    /**
     * Ask for installment conditions and price
     * @param token Unique transaction identifier
     * @param installmentsNumber Number of installments to ask for
     */
    async installments(token, installmentsNumber) {
        ValidationUtil.hasTextWithMaxLength(token, ApiConstants.TOKEN_LENGTH, "token");
        return RequestService.perform(new InstallmentsRequest(token, installmentsNumber), this.options);
    }
    /**
     * Commit a transaction
     * @param token Unique transaction identifier
     * @param idQueryInstallments (Optional) Use this when paying with installments, get it from
     * installments method.
     * @param deferredPeriodIndex (Optional) Use this when paying with installments, you can use this
     * if the commerce is configured to offer deferred payment
     * @param gracePeriod (Optional) Use this when paying with installments, this indicates if there's
     * a grace period.
     */
    async commit(token, idQueryInstallments = undefined, deferredPeriodIndex = undefined, gracePeriod = undefined) {
        ValidationUtil.hasTextWithMaxLength(token, ApiConstants.TOKEN_LENGTH, "token");
        let commitRequest = new CommitRequest(token, idQueryInstallments, deferredPeriodIndex, gracePeriod);
        return RequestService.perform(commitRequest, this.options);
    }
    /**
     * Obtain the status of a specific transaction
     * @param token Unique transaction identifier
     */
    async status(token) {
        ValidationUtil.hasTextWithMaxLength(token, ApiConstants.TOKEN_LENGTH, "token");
        return RequestService.perform(new StatusRequest(token), this.options);
    }
    /**
     * Request a refund of a specific transaction, if you refund for the full amount and you're within
     * the time window the transaction will be reversed. If you're past that window or refund for less
     * than the total amount the transaction will be void.
     * @param token Unique transaction identifier
     * @param amount Amount to be refunded
     */
    async refund(token, amount) {
        ValidationUtil.hasTextWithMaxLength(token, ApiConstants.TOKEN_LENGTH, "token");
        let refundRequest = new RefundRequest(token, amount);
        return RequestService.perform(refundRequest, this.options);
    }
    /** Capture a deferred transaction.
     *
     * Your commerce code must be configured to support deferred capture.
     *
     * @param token Unique transaction identifier
     * @param buyOrder Transaction's buy order
     * @param authorizationCode Transaction's authorization code
     * @param captureAmount Amount to be captured
     */
    async capture(token, buyOrder, authorizationCode, captureAmount) {
        ValidationUtil.hasTextWithMaxLength(token, ApiConstants.TOKEN_LENGTH, "token");
        ValidationUtil.hasTextWithMaxLength(buyOrder, ApiConstants.BUY_ORDER_LENGTH, "buyOrder");
        ValidationUtil.hasTextWithMaxLength(authorizationCode, ApiConstants.AUTHORIZATION_CODE_LENGTH, "authorizationCode");
        let captureRequest = new CaptureRequest(token, buyOrder, authorizationCode, captureAmount);
        return RequestService.perform(captureRequest, this.options);
    }
}
;
export default Transaction;