Docs
Docs

Begin-transaction-guest: Nueva transacción para pago con usuario invitado

Descripción

Con este endpoint, podrás obtener el ID único para realizar un pago sin tener dado de alta a un usuario.


Method: post
URL: https://{enviroment-domain}/api/v1/begin-transaction-guest

Encabezados HTTP: Content-Type: application/json
Agregar encabezados de autenticación

Ejemplo:

Body

{
  "transactionType": "sale",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "urlNotification": "https://merchant.com/notify",
  "order": {
    "title": "Título",
    "amount": "10",
    "currency": "MXN"
  }
}

Descripción de campos

CampoDescripción
TransactionTypeIndica el tipo de transacción. En este caso, debe ser "sale".
MerchantIdIdentificador único del comerciante en la pasarela de pago, es asignado al momento de crear la cuenta.
UrlNotificationURL proporcionada por el comercio en donde se notifica el resultado.
OrderEncapsula los datos de la orden.
TitleTítulo que mostrará la carta de pago
AmountMonto total de la orden.
CurrencyCódigo de moneda según el estándar ISO 4217.

Ejemplo de respuesta exitosa

Http code 200

{
    "payload": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "isSuccess": true
}

Ejemplos de respuesta con error

Http code 400

El monto no es un valor positivo

{
    "isSuccess": false,
    "errors": [
        {
            "key": "Order.Amount",
            "value": [
                "The specified condition was not met for 'Order Amount'."
            ]
        }
    ]
}

Descripción de campos

CampoDescripción
IsSuccessIndica si la petición se pudo completar satisfactoriamente.
PayloadRespuesta solicitada a nuestro sistema.
IdId único para la operación de pago con usuario invitado
ErrorsUna lista de errores que ocurrieron en la petición.
KeyLlave del error
ValueBreve descripción del error.


📘

CONSIDERACIONES IMPORTANTES

  • El campo TransactionType siempre debe ser sale.
  • El Id regresado sólo podrá ser usado para la operación de pago con usuario invitado.
  • El Id no podrá ser utilizado más de una vez.
  • El Id es único y tiene una duración de 1 hr a partir de su creación.
  • El campo Id es el valor que el comercio debe de guardar como referencia para futuras aclaraciones acerca de la transacción.
  • Cuando se procese de manera exitosa este pago, el sistema regresará el token de la tarjeta, ya sea consultando el endpoint Status o como respuesta que regresará nuestro sdk.