Docs
Docs

Captura

La transacción de captura en nuestra pasarela de pagos es una función que permite a los comercios finalizar y confirmar la autorización de una transacción previamente preautorizada. A continuación, se presenta una descripción detallada de cómo se lleva a cabo la transacción de captura en nuestra plataforma.

📘

Notas importantes

  • El período de espera entre la preautorización y la captura varía según los emisores y puede estar sujeto a límites de tiempo específicos.
  • La preautorización permite al comerciante asegurarse de que los fondos estén disponibles antes de comprometerse completamente con la transacción.
  • Este flujo es comúnmente utilizado en industrias como la hotelera o alquiler de coches, donde es necesario garantizar la disponibilidad de fondos antes de la llegada del cliente.

Este endpoint recibe los datos de la transacción de captura y devuelve el resultado.
Method: post
URL: http://{environment-domain}/api/v1/capture
Encabezados HTTP: Content-Type: application/json
Agregar encabezados de autenticación

Ejemplo

{
  "id": "5c51bebd-5b21-4ef3-b980-d41eb0b83568",
  "merchantId": "3ae25846-d5fe-40cc-a311-eb2de5174c29",
  "terminalId": "3ae25846-d5fe-40cc-a311-eb2de5174c29",
  "order": {
    "merchantOrderId": "9a6ecf36-8265-11ee-b962-0242ac120002",
    "amount": "100.00",
    "currency": "484"
  }
}

Descripción de campos

CampoDescripción
idId único de la transacción asignado por la pasarela de pagos.
merchantIdIdentificador único del comerciante en la pasarela de pago es asignado al momento de crear la cuenta.
terminalIdIdentificador único de la terminal es asignado al momento de crear la cuenta.
orderContiene detalles sobre la orden de compra.
merchantOrderIdIdentificador único de la orden asignado por el comercio.
amountMonto total de la orden.
currencyCódigo de moneda según el estándar ISO 4217.

Ejemplo de respuesta exitosa:

Http code 200

{
  "id": "63fa692e-66fe-47a0-acdd-50c13970d4f3",
  "order": {
    "id": "9a6ecf36-8265-11ee-b962-0242ac120002",
    "amount": "100.00",
    "currency": "484"
  },
  "payload": {
    "paymentId": "4d0cbd45-bc39-4d17-96ef-34affa296bde",
    "responseCode": "00",
    "responseDescription": "Approved or completed successfully (if balances are available)",
    "authorizationNumber": "280188",
    "referenceNumber": "000027389440",
    "status": "Paid"
  },
  "isApproved": true,
  "isFailure": false,
  "errors": null
} 

Descripción de campos

CampoDescripción
idId único de la transacción asignado por la pasarela de pagos.
orderContiene detalles sobre la orden de compra.
merchantOrderIdIdentificador único de la orden asignado por el comercio.
amountMonto total de la orden.
currencyCódigo de moneda según el estándar ISO 4217.
payloadContiene información detallada sobre la transacción.
paymentIdIdentificador único de la transacción de pago.
responseCodeCódigo de respuesta que indica el resultado de la transacción (en este caso, "00" indica aprobación).
responseDescriptionDescripción asociada al código de respuesta.
authorizationNumberNúmero de autorización de la transacción.
referenceNumberNúmero de referencia asociado a la transacción.
statusEstado de la transacción, en este caso, "Paid" indica que la transacción ha sido completada con éxito.
isApprovedIndica si la transacción fue aprobada. En este ejemplo, es “true”, lo que significa que la transacción fue aprobada.
isFailureIndica si la transacción ha fallado. En este ejemplo, es “false”, indicando que la transacción no ha fallado.
errorsContiene detalles como número de error y una descripción, si los hubiera. En este caso, es “null”, lo que significa que no se han producido errores en la transacción.