Webpay Plus

Ambientes y Credenciales

La API REST de Webpay está protegida para garantizar que solamente comercios autorizados por Transbank hagan uso de las operaciones disponibles. La seguridad esta implementada mediante los siguientes mecanismos:

• Canal seguro a través de TLSv1.2 para la comunicación del cliente con Webpay.
• Autenticación y autorización mediante el intercambio de headers Tbk-Api-Key-Id (código de comercio) y Tbk-Api-Key-Secret (llave secreta).

Ambiente de Producción

Las URLs de endpoints de producción están alojados dentro de https://webpay3g.transbank.cl/.

// Host: https://webpay3g.transbank.cl

// Host: https://webpay3g.transbank.cl

// Host: https://webpay3g.transbank.cl

# Host: https://webpay3g.transbank.cl

# Host: https://webpay3g.transbank.cl

Host: https://webpay3g.transbank.cl

Ambiente de Integración

Las URLs de endpoints de integración están alojados dentro de https://webpay3gint.transbank.cl/.

// Host: https://webpay3gint.transbank.cl

// Host: https://webpay3gint.transbank.cl

// Host: https://webpay3gint.transbank.cl

# Host: https://webpay3gint.transbank.cl

# Host: https://webpay3g.transbank.cl

Host: https://webpay3gint.transbank.cl

Consulta la documentación para conocer las tarjetas de prueba que funcionan en el ambiente de integración.

Credenciales del Comercio

// Tbk-Api-Key-Id: Código de comercio
// Tbk-Api-Key-Secret: Llave secreta
// Content-Type: application/json

// Tbk-Api-Key-Id: Código de comercio
// Tbk-Api-Key-Secret: Llave secreta
// Content-Type: application/json

// Tbk-Api-Key-Id: Código de comercio
// Tbk-Api-Key-Secret: Llave secreta
// Content-Type: application/json

# Tbk-Api-Key-Id: Código de comercio
# Tbk-Api-Key-Secret: Llave secreta
# Content-Type: application/json

# Tbk-Api-Key-Id: Código de comercio
# Tbk-Api-Key-Secret: Llave secreta
# Content-Type: application/json

Tbk-Api-Key-Id: Código de comercio
Tbk-Api-Key-Secret: Llave secreta
Content-Type: application/json

Todas las peticiones que hagas deben incluir el código de comercio y la llave secreta entregada por Transbank, actuando ambas como las credenciales que autorizan distintas operaciones.

Códigos de comercio

En la documentación puedes revisar todos los códigos de comercio del ambiente de integración

Los SDKs ya incluyen esos códigos de comercio y llaves secretas que funcionan en el ambiente de integración, por lo que puedes obtener rápidamente una configuración lista para hacer tus primeras pruebas en dicho ambiente:

WebpayPlus.Transaction tx = new WebpayPlus.Transaction(new WebpayOptions(IntegrationCommerceCodes.WEBPAY_PLUS, IntegrationApiKeys.WEBPAY, IntegrationType.TEST));

use Transbank\Webpay\Options;
use Transbank\Webpay\WebpayPlus\Transaction;
$option = new Options($apiKey, $commerceCode, Options::ENVIRONMENT_INTEGRATION);
$transaction = new Transaction($option);

var tx = new Transaction(new Options(IntegrationCommerceCodes.WEBPAY_PLUS, IntegrationApiKeys.WEBPAY, WebpayIntegrationType.Test));

@tx = Transbank::Webpay::WebpayPlus::Transaction.new(::Transbank::Common::IntegrationCommerceCodes::WEBPAY_PLUS, ::Transbank::Common::IntegrationApiKeys::WEBPAY, :integration)

tx = Transaction(WebpayOptions(IntegrationCommerceCodes.WEBPAY_PLUS, IntegrationApiKeys.WEBPAY, IntegrationType.TEST))

const tx = new WebpayPlus.Transaction(

new Options(
IntegrationCommerceCodes.WEBPAY_PLUS,
IntegrationApiKeys.WEBPAY,
Environment.Integration)
);

Tbk-Api-Key-Id: 597055555532
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C

Webpay Plus

Una transacción de autorización normal (o transacción normal), corresponde a una solicitud de autorización financiera de un pago con tarjetas de crédito o débito, en donde quién realiza el pago ingresa al sitio del comercio, selecciona productos o servicio, y el ingreso asociado a los datos de la tarjeta de crédito, débito o prepago lo realiza en forma segura en Webpay.

Flujo en caso de éxito y abortar un pago

Revisa la documentación de Webpay plus para revisar los diferentes flujos de pago posibles.

Crear una transacción

Puedes revisar más detalles de esta operación en su documentación

Permite inicializar una transacción en Webpay. Como respuesta a la invocación se genera un token que representa en forma única una transacción.

Para crear una transacción basta llamar al método Transaction.create()

WebpayPlus.Transaction transaction = WebpayPlus.Transaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusTransactionCreateResponse response = transaction.create(buyOrder, sessionId, amount, returnUrl);

$transaction = Transaction::buildForIntegration($apiKey, $commerceCode);
$response = $transaction->create($buy_order, $session_id, $amount, $return_url);

Transaction transaction = Transaction.buildForIntegration("commerceCode", "APIKey");
var response = transaction.Create(buyOrder, sessionId, amount, returnUrl);
  

@transaction = Transbank::Webpay::WebpayPlus::Transaction.build_for_integration("commerceCode", "APIKey");
@resp = @transaction.create(
  buy_order: @buy_order,
  session_id: @session_id,
  amount: @amount,
  return_url: @return_url
);
  
  

tx = Transaction.build_for_integration("commerceCode", "APIKey")
resp = tx.create(buy_order, session_id, amount, return_url)

const transaction = WebpayPlus.Transaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await transaction.create(
  buyOrder,
  sessionId,
  amount,
  returnUrl
);

POST /rswebpaytransaction/api/webpay/v1.2/transactions

Tbk-Api-Key-Id: 597055555532
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
 "buy_order": "ordenCompra12345678",
 "session_id": "sesion1234557545",
 "amount": 10000,
 "return_url": "http://www.comercio.cl/webpay/retorno"
}

Parámetros Transaction.create

Respuesta Transaction.create

response.getUrl();
response.getToken();

// Puedes obtener la URL y el token devuelo utilizando estos métodos del objeto de respuesta:

$response->getUrl();
$response->getToken();

response.Url;
response.Token;

response.url
response.token

## Versión 3.x del SDK
response['url']
response['token']

## Versión 2.x del SDK
response.url
response.token

response.url
response.token

200 OK
Content-Type: application/json

{
 "token": "e9d555262db0f989e49d724b4db0b0af367cc415cde41f500a776550fc5fddd3",
 "url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction"
}

Confirmar una transacción

Puedes revisar más detalles de esta operación en su documentación

Permite confirmar y obtener el resultado de la transacción una vez que Webpay ha resuelto su autorización financiera.

Cuando el comercio retoma el control mediante return_url debes confirmar y obtener el resultado de una transacción usando el método Transaction.commit().

WebpayPlus.Transaction transaction = WebpayPlus.Transaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusTransactionCommitResponse response = transaction.commit(token);

$transaction = Transaction::buildForIntegration($apiKey, $commerceCode);
$response = $transaction->commit($token); 

Transaction transaction = Transaction.buildForIntegration("commerceCode", "APIKey");
var response = transaction.Commit(token);

@transaction = Transbank::Webpay::WebpayPlus::Transaction.build_for_integration("commerceCode", "APIKey");
@resp = @transaction.commit(token: @token);

tx = Transaction.build_for_integration("commerceCode", "APIKey")
resp = tx.commit(token)

const transaction = WebpayPlus.Transaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await transaction.commit(token);

PUT /rswebpaytransaction/api/webpay/v1.2/transactions/{token}
Tbk-Api-Key-Id: 597055555532
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

Parámetros Transaction.commit

Respuesta Transaction.commit

response.getVci();
response.getAmount();
response.getStatus();
response.getBuyOrder();
response.getSessionId();
response.getCardDetail().getCardNumber();
response.getAccountingDate();
response.getTransactionDate();
response.getAuthorizationCode();
response.getPaymentTypeCode();
response.getResponseCode();
response.getInstallmentsAmount();
response.getInstallmentsNumber();
response.getBalance();

$response->getVci();
$response->getAmount();
$response->getStatus();
$response->getBuyOrder();
$response->getSessionId();
$response->getCardDetail();
$response->getAccountingDate();
$response->getTransactionDate();
$response->getAuthorizationCode();
$response->getPaymentTypeCode();
$response->getResponseCode();
$response->getInstallmentsAmount();
$response->getInstallmentsNumber();
$response->getBalance();

response.Vci;
response.Amount;
response.Status;
response.BuyOrder;
response.SessionId;
response.CardDetail;
response.AccountingDate;
response.TransactionDate;
response.AuthorizationCode;
response.PaymentTypeCode;
response.ResponseCode;
response.InstallmentsAmount;
response.InstallmentsNumber;
response.Balance;

response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

## Versión 3.x del SDK
response['vci']
response['amount']
response['status']
response['buy_order']
response['session_id']
response['card_detail']
response['accounting_date']
response['transaction_date']
response['authorization_code']
response['payment_type_code']
response['response_code']
response['installments_amount']
response['installments_number']
response['balance']

## Versión 2.x del SDK
response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

200 OK
Content-Type: application/json

{
  "vci": "TSY",
  "amount": 10000,
  "status": "AUTHORIZED",
  "buy_order": "ordenCompra12345678",
  "session_id": "sesion1234557545",
  "card_detail": {
      "card_number": "6623"
  },
  "accounting_date": "0522",
  "transaction_date": "2019-05-22T16:41:21.063Z",
  "authorization_code": "1213",
  "payment_type_code": "VN",
  "response_code": 0,
  "installments_number": 0
}

Obtener estado de una transacción

Puedes revisar más detalles de esta operación en su documentación

Esta operación permite obtener el estado de la transacción en cualquier momento. En condiciones normales es probable que no se requiera ejecutar, pero en caso de ocurrir un error inesperado permite conocer el estado y tomar las acciones que correspondan.

Transaction.status()

WebpayPlus.Transaction transaction = WebpayPlus.Transaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusTransactionStatusResponse response = transaction.status(token); 

  
$transaction = Transaction::buildForIntegration($apiKey, $commerceCode);
$response = $transaction->status($token);

using Transbank.Webpay.WebpayPlus;

Transaction transaction = Transaction.buildForIntegration("commerceCode", "APIKey");
var response = transaction.status(token);

@transaction = Transbank::Webpay::WebpayPlus::Transaction.build_for_integration("commerceCode", "APIKey");
@resp = @transaction.status(token: @token); 

tx = Transaction.build_for_integration("commerceCode", "APIKey")
resp = tx.status(token)

const transaction = WebpayPlus.Transaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await transaction.status(token);
  

GET /rswebpaytransaction/api/webpay/v1.2/transactions/{token}
Tbk-Api-Key-Id: 597055555532
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

Parámetros Transaction.status

Respuesta Transaction.status

response.getVci();
response.getAmount();
response.getStatus();
response.getBuyOrder();
response.getSessionId();
response.getCardDetail().getCardNumber();
response.getAccountingDate();
response.getTransactionDate();
response.getAuthorizationCode();
response.getPaymentTypeCode();
response.getResponseCode();
response.getInstallmentsAmount();
response.getInstallmentsNumber();
response.getBalance();

$response->getVci();
$response->getAmount();
$response->getStatus();
$response->getBuyOrder();
$response->getSessionId();
$response->getCardDetail();
$response->getAccountingDate();
$response->getTransactionDate();
$response->getAuthorizationCode();
$response->getPaymentTypeCode();
$response->getResponseCode();
$response->getInstallmentsAmount();
$response->getInstallmentsNumber();
$response->getBalance();

response.Vci;
response.Amount;
response.Status;
response.BuyOrder;
response.SessionId;
response.CardDetail;
response.AccountingDate;
response.TransactionDate;
response.AuthorizationCode;
response.PaymentTypeCode;
response.ResponseCode;
response.InstallmentsAmount;
response.InstallmentsNumber;
response.Balance;

response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

## Versión 3.x del SDK
response['vci']
response['amount']
response['status']
response['buy_order']
response['session_id']
response['card_detail']
response['accounting_date']
response['transaction_date']
response['authorization_code']
response['payment_type_code']
response['response_code']
response['installments_amount']
response['installments_number']
response['balance']

## Versión 2.x del SDK
response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

response.vci
response.amount
response.status
response.buy_order
response.session_id
response.card_detail
response.accounting_date
response.transaction_date
response.authorization_code
response.payment_type_code
response.response_code
response.installments_amount
response.installments_number
response.balance

200 OK
Content-Type: application/json

{
  "vci": "TSY",
  "amount": 10000,
  "status": "AUTHORIZED",
  "buy_order": "ordenCompra12345678",
  "session_id": "sesion1234557545",
  "card_detail": {
      "card_number": "6623"
  },
  "accounting_date": "0522",
  "transaction_date": "2019-05-22T16:41:21.063Z",
  "authorization_code": "1213",
  "payment_type_code": "VN",
  "response_code": 0,
  "installments_number": 0
}

Reversar o Anular un pago

Puedes revisar más detalles de esta operación en su documentación

Para anular una transacción se debe invocar al método Transaction.refund().

Transaction.refund()

Los SDKs permiten indicar opcionalmente el código de comercio de la transacción a anular, para soportar la anulación en comercios Webpay Plus Mall. En comercios Webpay Plus, no es necesario especificar el código de comercio pues se usa el indicado en la configuración.

WebpayPlus.Transaction transaction = WebpayPlus.Transaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusTransactionRefundResponse response = transaction.refund(token, amount);

$transaction = Transaction::buildForIntegration($apiKey, $commerceCode);
$response = $transaction->refund($token, $amount);

Transaction transaction = Transaction.buildForIntegration("commerceCode", "APIKey");
var response = transaction.Refund(token, refundAmount);

@transaction = Transbank::Webpay::WebpayPlus::Transaction.build_for_integration("commerceCode", "APIKey");
@resp = @transaction.refund(token: @token, amount: @amount); 
  

tx = Transaction.build_for_integration("commerceCode", "APIKey")
resp = tx.refund(token, amount)  

const transaction = WebpayPlus.Transaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await transaction.refund(token, amount);

POST /rswebpaytransaction/api/webpay/v1.2/transactions/{token}/refunds
Tbk-Api-Key-Id: 597055555532
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
  "amount": 1000
}

Parámetros Transaction.refund

Respuesta Transaction.refund

En el caso de que la transacción corresponda a una Reversa solo se retorna el parámetro type (REVERSED).

response.getAuthorizationCode();
response.getAuthorizationDate();
response.getBalance();
response.getNullifiedAmount();
response.getResponseCode();
response.getType();

// Puedes obtener los datos de la respuesta usando cualquiera de estos métedos del objeto de respuesta: 

$response->getAuthorizationCode();
$response->getAuthorizationDate();
$response->getBalance();
$response->getNullifiedAmount();
$response->getResponseCode();
$response->getType();

response.AuthorizationCode;
response.AuthorizationDate;
response.Balance;
response.NullifiedAmount;
response.ResponseCode;
response.Type;

response.authorization_code;
response.authorization_date;
response.balance;
response.nullified_amount;
response.response_code;
response.type;

## Versión 3.x del SDK
response['authorization_code']
response['authorization_date']
response['balance']
response['nullified_amount']
response['response_code']
response['type']

## Versión 2.x del SDK
response.authorization_code
response.authorization_date
response.balance
response.nullified_amount
response.response_code
response.type

response.authorization_code
response.authorization_date
response.balance
response.nullified_amount
response.response_code
response.type

200 OK
Content-Type: application/json
{
  "type": "NULLIFIED",
  "authorization_code": "123456",
  "authorization_date": "2019-03-20T20:18:20Z",
  "nullified_amount": 1000.00,
  "balance": 0.00,
  "response_code": 0
}

En caso de error pueden aparecer los siguientes códigos de error comunes para el método Transaction.refund():

Capturar una transacción

Puedes revisar más detalles de esta operación en su documentación

Permite solicitar a Webpay la captura diferida de una transacción con autorización y sin captura simultánea.

Transaction.capture()

WebpayPlus.Transaction transaction = WebpayPlus.Transaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusTransactionCaptureResponse response = transaction.capture(token, buyOrder, authorizationCode, amount);

use Transbank\Webpay\WebpayPlus\Transaction;

$transaction = Transaction::buildForIntegration($apiKey, $commerceCode);
$response = $transaction->capture($token, $buyOrder, $authCode, $amount);

Transaction transaction = Transaction.buildForIntegration("commerceCode", "APIKey");
var response = transaction.capture(token, buyOrder, authorizationCode, amount);

@transaction = Transbank::Webpay::WebpayPlus::Transaction.build_for_integration("commerceCode", "APIKey");
@resp = @transaction.capture(
  token: @token,
  buy_order: @buy_order,
  authorization_code: @auth_code,
  amount: @amount
);

tx = Transaction.build_for_integration("commerceCode", "APIKey")
resp = tx.capture(
  token=token, buy_order=buy_order, authorization_code=authorization_code, capture_amount=amount
)

const transaction = WebpayPlus.Transaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await tx.capture(
  token,
  buyOrder,
  authorizationCode,
  captureAmount
);

PUT /rswebpaytransaction/api/webpay/v1.2/transactions/{token}/capture
Tbk-Api-Key-Id: 597055555540
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
  "buy_order": "415034240",
  "authorization_code": "12345",
  "capture_amount": 1000
}

Parámetros Transaction.capture

Respuesta Transaction.capture

response.getAuthorizationCode();
response.getAuthorizationDate();
response.getCapturedAmount();
response.getResponseCode();

$response->getAuthorizationCode();
$response->getAuthorizationDate();
$response->getCapturedAmount();
$response->getResponseCode();

response.AuthorizationCode;
response.AuthorizationDate;
response.CapturedAmount;
response.ResponseCode;

response.authorization_code
response.authorization_date
response.captured_amount
response.response_code

## Versión 3.x del SDK
response['authorization_code']
response['authorization_date']
response['captured_amount']
response['response_code']

## Versión 2.x del SDK
response.authorization_code
response.authorization_date
response.captured_amount
response.response_code

response.authorization_code
response.authorization_date
response.captured_amount
response.response_code

200 OK
Content-Type: application/json
{
  "token": "e074d38c628122c63e5c0986368ece22974d6fee1440617d85873b7b4efa48a3",
  "authorization_code": "123456",
  "authorization_date": "2019-03-20T20:18:20Z",
  "captured_amount": 1000,
  "response_code": 0
}

En caso de error pueden aparecer los siguientes códigos exclusivos del método Transaction.capture():

Webpay Plus Mall

Una transacción Mall Normal corresponde a una solicitud de autorización financiera de un conjunto de pagos con tarjetas de crédito o débito, en donde quién realiza el pago ingresa al sitio del comercio, selecciona productos o servicios, y el ingreso asociado a los datos de la tarjeta de crédito o débito lo realiza una única vez en forma segura en Webpay para el conjunto de pagos. Cada pago tendrá su propio resultado, autorizado o rechazado.

Revisa más detalles sobre esta modalidad en la documentación

Crear una transacción mall

Puedes revisar más detalles de esta operación en su documentación

Para crear una transacción basta llamar al método Transaction.create()

Transaction.create() Mall

WebpayPlus.MallTransaction mallTransaction = WebpayPlus.MallTransaction.buildForIntegration("commerceCode", "APIKey");
MallTransactionCreateDetails mallDetails = MallTransactionCreateDetails.build()
                .add(amountMallOne, commerceCodeStoreOne, buyOrderMallOne)
                .add(amountMallTwo, commerceCodeStoreTwo, buyOrderMallTwo);
final WebpayPlusMallTransactionCreateResponse response = mallTransaction.create(buyOrder, sessionId, returnUrl, mallDetails);

  
$mallTransaction = MallTransaction::buildForIntegration($apiKey, $commerceCode);
$transaction_details = [
  [
      "amount" => 10000,
      "commerce_code" => 'commerceCodeStoreOne',
      "buy_order" => "ordenCompraDetalle1234"
  ],
  [
      "amount" =>12000,
      "commerce_code" => 'commerceCodeStoreTwo',
      "buy_order" => "ordenCompraDetalle4321"
  ],
];
$response = $mallTransaction->create($buy_order, $session_id, $return_url, $transaction_details);

MallTransaction mallTransaction = MallTransaction.buildForIntegration("commerceCode", "APIKey");
var transactionDetails = new List();
transactionDetails.Add(new TransactionDetail(
    amountMallOne,
    commerceCodeStoreOne,
    buyOrderMallOne
));
transactionDetails.Add(new TransactionDetail(
    amountMallTwo,
    commerceCodeStoreTwo,
    buyOrderMallTwo
));
var result = mallTransaction.Create(buyOrder, sessionId, returnUrl, transactionDetails);
  

@mall_transaction = Transbank::Webpay::WebpayPlus::MallTransaction.build_for_integration("commerceCode", "APIKey");
@transaction_details = [
  {
      amount: 10000,
      commerce_code: "commerce_store_1",
      buy_order: "ordenCompraDetalle1234"
  },
  {
      amount: 12000,
      commerce_code: "commerce_store_2",
      buy_order: "ordenCompraDetalle4321"
  },
];
@resp = @mall_transaction.create(
  buy_order: @buy_order,
  session_id: @session_id,
  return_url: @return_url,
  details: @transaction_details
);

  
mall_tx = MallTransaction.build_for_integration("commerceCode", "APIKey")
transaction_details = MallTransactionCreateDetails(
  amount_child_1, commerce_store_1, buy_order_child_1
).add(
  amount_child_2, commerce_store_2, buy_order_child_2
)
resp = mall_tx.create(
    buy_order=buy_order,
    session_id=session_id,
    return_url=return_url,
    details = transaction_details,
)

const mallTransaction = WebpayPlus.MallTransaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
let details = [
  new TransactionDetail(amount, commerceCodeStoreOne, buyOrder),
  new TransactionDetail(amount2, commerceCodeStoreTwo, buyOrder2),
];
const response = await mallTransaction.create(
  buyOrder,
  sessionId,
  returnUrl,
  details
);

POST /rswebpaytransaction/api/webpay/v1.2/transactions

Tbk-Api-Key-Id: 597055555535
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
 "buy_order": "ordenCompra12345678",
 "session_id": "sesion1234557545",
 "return_url": "http://www.comercio.cl/webpay/retorno",
 "details": [
     {
         "amount": 10000,
         "commerce_code": 597055555536,
         "buy_order": "ordenCompraDetalle1234"
     },
     {
        "amount": 12000,
        "commerce_code":  597055555537,
        "buy_order": "ordenCompraDetalle4321"
     },
 ]
}

Parámetros Transaction.create Mall

Respuesta Transaction.create() Mall

response.getToken();
response.getUrl();

$response->getToken();
$response->getUrl();

response.Token;
response.Url;

response.token
response.url

## Versión 3.x del SDK
response['token']
response['url']

## Versión 2.x del SDK
response.token
response.url

response.token
response.url

200 OK
Content-Type: application/json

{
 "token": "e9d555262db0f989e49d724b4db0b0af367cc415cde41f500a776550fc5fddd3",
 "url": "https://webpay3gint.transbank.cl/webpayserver/initTransaction"
}

Confirmar una transacción mall

Puedes revisar más detalles de esta operación en su documentación

Permite confirmar una tranascción y obtener el resultado de la transacción una vez que Webpay ha resueltosu autorización financiera.

Transaction.commit() Mall

WebpayPlus.MallTransaction mallTransaction = WebpayPlus.MallTransaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusMallTransactionCommitResponse response = mallTransaction.commit(token);

$mallTransaction = MallTransaction::buildForIntegration($apiKey, $commerceCode);
$response = $mallTransaction->commit($token);

using Transbank.Webpay.WebpayPlus;

MallTransaction mallTransaction = MallTransaction.buildForIntegration("commerceCode", "APIKey");
var response = mallTransaction.Commit(token);

@mall_transaction = Transbank::Webpay::WebpayPlus::MallTransaction.build_for_integration("commerceCode", "APIKey");
@resp = @mall_transaction.commit(token: @token);

mall_tx = MallTransaction.build_for_integration("commerceCode", "APIKey")
resp = mall_tx.commit(token)

const mallTransaction = WebpayPlus.MallTransaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await mallTransaction.commit(token); 
    
  

PUT /rswebpaytransaction/api/webpay/v1.2/transactions/{token}
Tbk-Api-Key-Id: 597055555535
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

Parámetros Transaction.commit Mall

Respuesta Transaction.commit Mall

response.getAccountingDate();
response.getBuyOrder();
final CardDetail cardDetail = response.getCardDetail();
cardDetail.getCardNumber();
response.getSessionId();
response.getTransactionDate();
response.getVci();
final List<Detail> details = response.getDetails();
for (Detail detail : details) {
    detail.getAmount();
    detail.getAuthorizationCode();
    detail.getBuyOrder();
    detail.getCommerceCode();
    detail.getInstallmentsNumber();
    detail.getPaymentTypeCode();
    detail.getResponseCode();
    detail.getStatus();
}

$response->getAccountingDate();
$response->getBuyOrder();
$response->getCardDetail();
$response->getCardNumber(); // Solo en SDK 2.x
$response->getSessionId();
$response->getTransactionDate();
$response->getVci();
$details = $response->getDetails();
foreach($details as $detail){ // En SDk 2.x cada $detail es un Objeto TransactionDetails
    $detail->getAmount();
    $detail->getAuthorizationCode();
    $detail->getBuyOrder();
    $detail->getCommerceCode();
    $detail->getInstallmentsNumber();
    $detail->getPaymentTypeCode();
    $detail->getResponseCode();
    $detail->getStatus();
    $detail->isApproved(); // Solo en SDK 2.x - Indica si esta sub transacción puede ser considerada como aprobada

}
$response->isApproved(); // Solo en SDK 2.x - Devuelve true si al menos una de las subtransacciones fue autorizada. 

response.AccountingDate;
response.BuyOrder;
var cardDetail = response.CardDetail;
cardDetail.CardNumber;
response.SessionId;
response.TransactionDate;
response.Vci;
var details = response.Details;
foreach (var detail in details) {
    detail.Amount;
    detail.AuthorizationCode;
    detail.BuyOrder;
    detail.CommerceCode;
    detail.InstallmentsNumber;
    detail.PaymentTypeCode;
    detail.ResponseCode;
    detail.Status;
}

response.accounting_date
response.buy_order
card_detail = response.card_detail
card_detail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
details.each do |detail|
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status
end

## Versión 3.x del SDK
response['accounting_date']
response['buy_order']
response['card_detail']
response['session_id']
response['transaction_date']
response['vci']

## Versión 2.x del SDK
response.accounting_date
response.buy_order
card_detail = response.card_detail
card_detail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
for detail in details:
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status

response.accounting_date
response.buy_order
cardDetail = response.card_detail
cardDetail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
details.forEach(detail => {
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status
});

200 OK
Content-Type: application/json

{
  "buy_order": "415034240",
  "card_detail": {
    "card_number": "6623"
  },
  "accounting_date": "0321",
  "transaction_date": "2019-03-21T15:43:48.523Z",
  "details": [
    {
      "amount": 10000,
      "status": "AUTHORIZED",
      "authorization_code": "1213",
      "payment_type_code": "VN",
      "response_code": 0,
      "installments_number": 0,
      "commerce_code": "597055555536",
      "buy_order": "505479072",
      "status": "AUTHORIZED"
  }]
}

Obtener estado de una transacción mall

Puedes revisar más detalles de esta operación en su documentación

Esta operación permite obtener el estado de la transacción en cualquier momento. En condiciones normales es probable que no se requiera ejecutar, pero en caso de ocurrir un error inesperado permite conocer el estado y tomar las acciones que correspondan.

Transaction.status() Mall

Obtiene resultado de transacción a partir de un token.

WebpayPlus.MallTransaction mallTransaction = WebpayPlus.MallTransaction.buildForIntegration("commerceCode", "APIKey");
final WebpayPlusMallTransactionStatusResponse response = mallTransaction.status(token);

$mallTransaction = MallTransaction::buildForIntegration($apiKey, $commerceCode);
$response = $mallTransaction->status($token);

MallTransaction mallTransaction = MallTransaction.buildForIntegration("commerceCode", "APIKey");
var response = mallTransaction.Status(token);

@mall_transaction = Transbank::Webpay::WebpayPlus::MallTransaction.build_for_integration("commerceCode", "APIKey");
@resp = @mall_transaction.status(token: @token);

mall_tx = MallTransaction.build_for_integration("commerceCode", "APIKey")
resp = mall_tx.status(token)  

const mallTransaction = WebpayPlus.MallTransaction.buildForIntegration(
  "commerceCode",
  "APIKey"
);
const response = await mallTransaction.status(token);

GET /rswebpaytransaction/api/webpay/v1.2/transactions/{token}
Tbk-Api-Key-Id: 597055555535
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

Parámetros Transaction.status Mall

Respuesta Transaction.status Mall

response.getAccountingDate();
response.getBuyOrder();
final CardDetail cardDetail = response.getCardDetail();
cardDetail.getCardNumber();
response.getSessionId();
response.getTransactionDate();
response.getVci();
final List<Detail> details = response.getDetails();
for (Detail detail : details) {
    detail.getAmount();
    detail.getAuthorizationCode();
    detail.getBuyOrder();
    detail.getCommerceCode();
    detail.getInstallmentsNumber();
    detail.getPaymentTypeCode();
    detail.getResponseCode();
    detail.getStatus();
}

$response->getAccountingDate();
$response->getBuyOrder();
$response->getCardDetail();
$response->getCardNumber(); // Solo en SDK 2.x
$response->getSessionId();
$response->getTransactionDate();
$response->getVci();
$details = $response->getDetails();
foreach($details as $detail){ // En SDk 2.x cada $detail es un Objeto TransactionDetails
    $detail->getAmount();
    $detail->getAuthorizationCode();
    $detail->getBuyOrder();
    $detail->getCommerceCode();
    $detail->getInstallmentsNumber();
    $detail->getPaymentTypeCode();
    $detail->getResponseCode();
    $detail->getStatus();
    $detail->isApproved(); // Solo en SDK 2.x - Indica si esta sub transacción puede ser considerada como aprobada

}
$response->isApproved(); // Solo en SDK 2.x - Devuelve true si al menos una de las subtransacciones fue autorizada.

response.AccountingDate;
response.BuyOrder;
var cardDetail = response.CardDetail;
cardDetail.CardNumber;
response.SessionId;
response.TransactionDate;
response.Vci;
var details = response.Details;
foreach (var detail in details) {
    detail.Amount;
    detail.AuthorizationCode;
    detail.BuyOrder;
    detail.CommerceCode;
    detail.InstallmentsNumber;
    detail.PaymentTypeCode;
    detail.ResponseCode;
    detail.Status;
}

response.accounting_date
response.buy_order
card_detail = response.card_detail
card_detail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
details.each do |detail|
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status
end

## Versión 3.x del SDK
response['accounting_date']
response['buy_order']
response['card_detail']
response['session_id']
response['transaction_date']
response['vci']

## Versión 2.x del SDK
response.accounting_date
response.buy_order
card_detail = response.card_detail
card_detail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
for detail in details:
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status

response.accounting_date
response.buy_order
cardDetail = response.card_detail
cardDetail.card_number
response.session_id
response.transaction_date
response.vci
details = response.details
details.forEach(detail => {
  detail.amount
  detail.authorization_code
  detail.buy_order
  detail.commerce_code
  detail.installments_number
  detail.payment_type_code
  detail.response_code
  detail.status
});

200 OK
Content-Type: application/json
{
  "buy_order": "415034240",
  "card_detail": {
    "card_number": "6623"
  },
  "accounting_date": "0321",
  "transaction_date": "2019-03-21T15:43:48.523Z",
  "vci": "TSY",
  "details": [
    {
      "amount": 10000,
      "status": "AUTHORIZED",
      "authorization_code": "1213",
      "payment_type_code": "VN",
      "response_code": 0,
      "installments_number": 0,
      "commerce_code": "597055555536",
      "buy_order": "505479072",
      "status": "AUTHORIZED"
  }]
}

Reversar o anular una transaccion mall

Puedes revisar más detalles de esta operación en su documentación

Este método permite a todo comercio habilitado reversar o anular una transacción que fue generada en Webpay Plus Mall.

Para anular una transacción se debe invocar al método Transaction.refund().

Transaction.refund() Mall

  WebpayPlus.MallTransaction mallTransaction = WebpayPlus.MallTransaction.buildForIntegration("commerceCode", "APIKey");
  final WebpayPlusTransactionRefundResponse response = mallTransaction.refund(token, childBuyOrder, commerceCodeStoreOne, amount);
  
  

  
  $mallTransaction = MallTransaction::buildForIntegration($apiKey, $commerceCode);
  $response = $mallTransaction->refund($token, $buy_order, $commerce_code, $amount);
  
  

  
  MallTransaction mallTransaction = MallTransaction.buildForIntegration("commerceCode", "APIKey");
  var response = mallTransaction.Refund(token, buyOrder, commerceCode, amount);
  
  

  
  @mall_transaction = Transbank::Webpay::WebpayPlus::MallTransaction.build_for_integration("commerceCode", "APIKey");
  @resp = @mall_transaction.refund(token: @token, buy_order: @child_buy_order, child_commerce_code: @commerce_store_1,  amount: @amount);
    
  

  
  mall_tx = MallTransaction.build_for_integration("commerceCode", "APIKey")
  resp = mall_tx.refund(token, child_buy_order, commerce_store_1, amount)
  
  

  
  const mallTransaction = WebpayPlus.MallTransaction.buildForIntegration(
    "commerceCode",
    "APIKey"
  );
  const response = await mallTransaction.refund(
    token,
    buyOrder,
    commerceCodeStoreOne,
    amount
  ); 
  
  

POST /rswebpaytransaction/api/webpay/v1.2/transactions/{token}/refunds
Tbk-Api-Key-Id: 597055555535
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
  "commerce_code": "597055555536",
  "buy_order": "ordenCompra12345678",
  "amount": 1000
}

Parámetros Transaction.refund Mall

Respuesta Transaction.refund Mall

En el caso de que la transacción corresponda a una Reversa solo se retorna el parámetro type (REVERSED).

response.getAuthorizationCode();
response.getAuthorizationDate();
response.getBalance();
response.getNullifiedAmount();
response.getResponseCode();
response.getType();

$response->getAuthorizationCode();
$response->getAuthorizationDate();
$response->getBalance();
$response->getNullifiedAmount();
$response->getResponseCode();
$response->getType();

response.AuthorizationCode;
response.AuthorizationDate;
response.Balance;
response.NullifiedAmount;
response.ResponseCode;
response.Type;

response.authorization_code
response.authorization_date
response.balance
response.nullified_amount
response.response_code
response.type

## Versión 3.x del SDK
response['authorization_code']
response['authorization_date']
response['balance']
response['nullified_amount']
response['response_code']
response['type']

## Versión 2.x del SDK
response.authorization_code
response.authorization_date
response.balance
response.nullified_amount
response.response_code
response.type

  response.authorization_code
  response.authorization_date
  response.balance
  response.nullified_amount
  response.response_code
  response.type

200 OK
Content-Type: application/json
{
  "type": "NULLIFIED",
  "authorization_code": "123456",
  "authorization_date": "2019-03-20T20:18:20Z",
  "nullified_amount": 1000.00,
  "balance": 0.00,
  "response_code": 0
}

En caso de error pueden aparecer los siguientes códigos de error comunes para el método Transaction.refund():

Capturar una transacción mall

Puedes revisar más detalles de esta operación en su documentación

Permite solicitar a Webpay la captura diferida de una transacción con autorización y sin captura simultánea.

Transaction.capture()

  WebpayPlus.MallTransaction mallTransaction = WebpayPlus.MallTransaction.buildForIntegration("commerceCode", "APIKey");
  final WebpayPlusMallTransactionCaptureResponse response = mallTransaction.capture(token, commerceCodeStoreOne, childBuyOrder, authorizationCode, amount);
  
  

  
  $mallTransaction = MallTransaction::buildForIntegration($apiKey, $commerceCode);
  $response = $mallTransaction->capture($commerceCodeStoreOne, $token, $buyOrder, $authorizationCode, $captureAmount);
  
  

  
  MallTransaction mallTransaction = MallTransaction.buildForIntegration("commerceCode", "APIKey");
  var response = mallTransaction.Capture(token, commerceCodeStoreOne, buyOrder, authorizationCode, captureAmount);
  
  

  
  @mall_transaction = Transbank::Webpay::WebpayPlus::MallTransaction.build_for_integration("commerceCode", "APIKey");
  @resp = @mall_transaction.capture(child_commerce_code: @commerce_store_1, token: @token, buy_order: @buy_order, authorization_code: @authorization_code, capture_amount: @capture_amount); 
  
  

  
  mall_tx = MallTransaction.build_for_integration("commerceCode", "APIKey")
  resp = mall_tx.capture(
    token=token, capture_amount=amount, commerce_code=commerce_store_1,
    buy_order=buy_order, authorization_code=authorization_code
  ) 
  

  
  const mallTransaction = WebpayPlus.MallTransaction.buildForIntegration(
    "commerceCode",
    "APIKey"
  );
  const response = await mallTransaction.capture(
    token,
    commerceCodeStoreOne,
    buyOrder,
    authorizationCode,
    captureAmount
  );
  
  

PUT /rswebpaytransaction/api/webpay/v1.2/transactions/{token}/capture
Tbk-Api-Key-Id: 597055555581
Tbk-Api-Key-Secret: 579B532A7440BB0C9079DED94D31EA1615BACEB56610332264630D42D0A36B1C
Content-Type: application/json

{
  "commerce_code": "597055555582",
  "buy_order": "your_buy_order_here",
  "authorization_code": "your_authorization_code_here",
  "capture_amount": 1000
}

Parámetros Transaction.capture

Respuesta Transaction.capture

response.getAuthorizationCode();
response.getAuthorizationDate();
response.getCapturedAmount();
response.getResponseCode();

$response->getAuthorizationCode();
$response->getAuthorizationCode();
$response->getAuthorizationDate();
$response->getCapturedAmount();
$response->getResponseCode();

response.AuthorizationCode;
response.AuthorizationDate;
response.CapturedAmount;
response.ResponseCode;

response.authorization_code
response.authorization_date
response.captured_amount
response.response_code

## Versión 3.x del SDK
response['authorization_code']
response['authorization_date']
response['captured_amount']
response['response_code']

## Versión 2.x del SDK
response.authorization_code
response.authorization_date
response.captured_amount
response.response_code

200 OK
Content-Type: application/json
{
  "token": "e074d38c628122c63e5c0986368ece22974d6fee1440617d85873b7b4efa48a3",
  "authorization_code": "123456",
  "authorization_date": "2019-03-20T20:18:20Z",
  "captured_amount": 1000,
  "response_code": 0
}

En caso de error pueden aparecer los siguientes códigos exclusivos del método Transaction.capture():

Códigos y mensajes de error

Al realizar cualquier solicitud al API REST, además de los datos de respuesta, se incluirá uno de los siguientes códigos de estado de respuesta HTTP dependiendo del resultado obtenido:

Solicitud exitosa

Cuando la operación solicitada es ejecutada correctamente, se pueden recibir estos status HTTP:

Códigos de error

Todos los errores reportados por la API REST de Webpay despliegan un mensaje JSON con una descripción del error.

{
  "error_message": "token is required"
}

Puesta en Producción

Puedes revisar el proceso necesario para operar en el ambiente de producción en la documentación

Configuración SDK

Los SDK deben configurarse explícitamente para apuntar al ambiente que quieras utilizar (producción / integración). Para esto puedes crear los objetos de 2 maneras:

• Utilizar los métodos definidos para ello (buildForIntegration o buildForProduction).
• Utilizar un objeto Options que contenga la configuración y pasarlo en el constructor de cada objeto.

Puede encontrar más información al respecto en este link

Configuración para producción utilizando los SDK

Si estas utilizando algún SDK oficial de Transbank, entonces debes seguir los siguientes pasos.

Revisa la esta sección de la documentación para ver el código necesario para configurar tu propio código de comercio y Api Key Secret.