Descripción

Con este endpoint, podrás consultar en nuestro sistema el estado de una transacción.

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

Agregar encabezados de autenticación

Ejemplo:

Body

{
  "id": "3d6ab0c1-a823-48fe-9a5f-6c17ca73c2cd",
  "merchantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Descripción de campos

Campo	Descripción
`Id`	Id único de la transacción asignado por nuestro sistema.
`MerchantId`	Identificador único del comerciante en la pasarela de pago, es asignado al momento de crear la cuenta.

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

Transacción no existente

{
    "isSuccess": false,
    "errors": [
        {
            "key": "ResourceNotFoundException",
            "value": [
                "Transaction for the Id 3d6ab0c1-a823-48fe-9a5f-6c17ca73c2c6 not found"
            ]
        }
    ]
}

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 Id que necesita la petición es el mismo que regresa los endpoints begin-transaction y make-payment-token cuando se inicia un proceso de pago.

Los valores de Status que se podrá recibir son: approved, void approved, refund approved y rejected.

El período en que se permite la consulta de estados de transacciones puede estar sujeto a límites de tiempo específicos.