Descripción

Con este endpoint, podrás generar pagos recurrentes server to server. La programación de la recurrencia queda del lado del comercio, nuestro sistema procesa el pago cuando llega la petición.

Method: post
URL: https://{enviroment-domain}/api/v1/make-payment-token

Agregar encabezados de autenticación

Ejemplo:

Body

{
  "transactionType": "sale",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customerId": "IdUser",
  "order": {
    "merchantOrderId": "merchantOrderId",
    "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.
`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.
`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": {
        "responseCode": "00",
        "responseDescription": "Message",
        "authorizationNumber": "123",
        "referenceNumber": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "status": "approved",
        "order" {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "amount": "10",
                "currency" "MXN"
        }
    },
    "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"
            ]
        }
    ]
}

Descripción de campos

Campo	Descripción
`IsSuccess`	Indica si la petición se pudo completar satisfactoriamente.
`Payload`	Respuesta solicitada a nuestro sistema.
`ResponseCode`	Código de respuesta que indica el resultado de la transacción (en este caso, "00" indica aprobación).
`ResponseDescription`	Descripción asociada al código de respuesta.
`AuthorizationNumber`	Número de autorización de la transacción.
`ReferenceNumber`	Número de referencia asociado a la transacción.
`Status`	Estado de la transacción, en este caso, "approved" indica que la transacción ha sido completada con éxito.
`Order`	Encapsula los datos de la orden.
`Id`	Id único de la transacción asignado por nuestro sistema.
`Amount`	Monto total de la orden.
`Currency`	Código de moneda según el estándar ISO 4217.
`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 campo Id es el valor que el comercio debe de guardar como referencia para futuras aclaraciones acerca de la transacción.

El campo status podrá ser solamente approved o rejected.