Descripción

Con este endpoint, podrás obtener el ID único para realizar un pago usando un token de una tarjeta guardada previamente.

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

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

Ejemplo:

Body

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

Descripción de campos

Campo	Descripción
`TransactionType`	Indica el tipo de transacción. En este caso, debe ser "sale".
`MerchantId`	Identificador único del comerciante en la pasarela de pago, es asignado al momento de crear la cuenta.
`CustomerId`	Identificador único del cliente. Este identificador lo asigna el propio comercio, es de tipo alfanumérico y no mayor a 100 caracteres.
`UrlNotification`	URL proporcionada por el comercio en donde se notifica el resultado.
`Order`	Encapsula los datos de la orden.
`MerchantOrderId`	Id de la orden asignada por el comercio. Esta debe de ser única para cada transacción realizada en nuestra plataforma.
`Title`	Título que mostrará la carta de pago
`Amount`	Monto total de la orden.
`Currency`	Código de moneda según el estándar ISO 4217.
`Card`	Encapsula los datos de la tarjeta.
`Token`	Token asignado a la tarjeta.

Ejemplo de respuesta exitosa

Http code 200

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

Ejemplos de respuesta con error

Http code 404

Usuario no existente

{
    "isSuccess": false,
    "errors": [
        {
            "key": "ResourceNotFoundException",
            "value": [
                "User does not exist: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IdUser"
            ]
        }
    ]
}

Http code 400

Llave duplicada

{
    "isSuccess": false,
    "errors": [
        {
            "key": "DuplicateKeyException",
            "value": [
                "Cannot insert duplicate key"
            ]
        }
    ]
}

Http code 404

Tarjeta no encontrada

{
    "isSuccess": false,
    "errors": [
        {
            "key": "ResourceNotFoundException",
            "value": [
                "Card not found: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IdUser 3fa85f64-5717-4562-b3fc-2c963f66afa6"
            ]
        }
    ]
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Payload`	Respuesta solicitada a nuestro sistema.
`Id`	Id único para la operación de pago con datos de tarjeta.
`Errors`	Una lista de errores que ocurrieron en la petición.
`Key`	Llave del error
`Value`	Breve descripción del error.

📘
CONSIDERACIONES IMPORTANTES

El campo TransactionType siempre debe ser sale.

El campo MerchantOrderId debe de ser un valor único por cada transacción que se realiza con nuestro sistema. Si se llegara a duplicar, nuestro sistema regresaría un error.

El Id regresado sólo podrá ser usado para la operación de pago con token.

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.