Skip to main content
Skip table of contents

API de Cancelación

El API de Cancelación permite cancelar una transacción generada anteriormente por el API de Autorización - ecommerce.

Con el método DELETE del orquestador, las transacciones se podrán cancelar o extornar segun el estado en la que se encuentra.

  • Transacciones con estado REGISTRADO o PENDIENTE, pasará a estado CANCELADO para los métodos:

    • CARD (Cuando es por Redirect)

    • CUOTEALO

    • QR

    • BANK_TRANSFER

    • PAGOEFECTIVO

  • Transacciones con estado AUTORIZADO, pasará a estado EXTORNADO para los métodos:

    • CARD

    • YAPE

REQUEST

Path

Method: DELETE

URL: {{base}}/charges/{{merchant_code}}/{{merchant_operation_number}}

Field

Description

Accepted Value

Type

merchant_code

Identificador del comercio

Cadena Alfanumérica

String

merchant_operation_number

Numero de operación

Cadena Alfanumérica

String

Headers

Para todos los métodos de pagos, se enviará los siguientes parámetros en la cabecera de la petición:

Field

Description

Accepted Value

Type

Authorization

Token de identificación para uso del API creado previamente en API de Seguridad

Cadena alfanumérica

String

RESPONSE

Se devolverá la misma respuesta que el API de Consulta con las transacciones que se pudieron extornar o cancelar de forma exitosa.

Field

Description

Accepted Value

Type

Obligatorio

success

Indica si el proceso se realizó correctamente

Cadena alfanumérica:

  • true

  • false

String

SI

merchant_code

Identificador del comercio

Cadena Alfanumérica

String

SI

merchant_operation_number

Número de pedido de la operación que fue cancelado o extornado

Cadena numérica mayor o igual de 6 dígitos

String

SI

operation

Visible cuando se encontro el merchant_operation_number

Objeto que contiene el detalle de la operación

 

Object

SI

operation.merchant_operation_number

Número de pedido de la operación que fue cancelado o extornado

Cadena numérica mayor o igual de 6 dígitos

String

SI

operation.amount

Monto de la operación

Cadena Numérica

String

SI

operation.currency

Código de la moneda de la operación

Cadena Numérica

String

SI

operation.state

Visible cuando la operación se pudo Extornar o Cancelar

Estado al cual se cambio la Operación

  • CANCELADO

  • EXTORNADO

String

SI

operation.transactions

Visible cuando la operación se pudo Extornar o Cancelar

Array que contiene el listado de transacciones extornadas o canceladas sobre la operación

Este objeto cambia según el método de pago:

 

Array

SI

meta

Objeto que contiene metadados del flujo ejecutado

 

Object

SI

meta.status

Objeto que contiene el resultado del flujo ejecutado

 

Object

SI

meta.status.code

Código que representa el resultado del flujo ejecutado

Cadena numérica

String

SI

meta.status.message_ilgn

Objeto que contiene el mensaje resultante del flujo

 

Object

SI

meta.status.message_ilgn.[].locale

Localidad a nivel de lenguaje para el mensaje del flujo ejecutado

Cadena alfanumérica

String

SI

meta.status.message_ilgn.[].value

Mensaje resultante del flujo ejecutado

Cadena alfanumérica

String

SI

Ejemplo Cancelación Exitosa

JSON
{
    "success": "true",
    "merchant_code": "abc",
    "operation": {
        "merchant_operation_number": "2836824",
        "amount": "1000",
        "currency": "604",
        "created_at": {
            "utc_time": "2024-07-05T16:46:12",
            "unix_time": 1720197972.923
        },
        "state": "CANCELADO",
        "transactions": [
            {
                "transaction_id": "9namjcnjvqzas2t33xyfrqr2h",
                "state": "CANCELADO",
                "state_reason": "Usuario canceló el método de pago",
                "amount": "1000",
                "currency": "604",
                "additional_fields": null,
                "payment_method": {
                    "method_name": "PAGOEFECTIVO",
                    "method_detail": {
                        "callback_url": "https://jjap9ekgee.execute-api.us-east-1.amazonaws.com/development/redirect/prueba/merchant_notification_response"
                    }
                },
                "expiration_date": null,
                "processor_response": null,
                "lifecycle": [
                    {
                        "state": "REGISTRADO",
                        "date": {
                            "utc_time": "2024-07-05T16:46:12",
                            "unix_time": 1720197972.931
                        }
                    },
                    {
                        "state": "PENDIENTE",
                        "date": {
                            "utc_time": "2024-07-05T16:46:13",
                            "unix_time": 1720197973.047
                        }
                    },
                    {
                        "state": "CANCELADO",
                        "date": {
                            "utc_time": "2024-07-05T16:47:22",
                            "unix_time": 1720198042.642
                        }
                    }
                ]
            }
        ]
    },
    "meta": {
        "status": {
            "code": "00",
            "message_ilgn": [
                {
                    "locale": "es_PE",
                    "value": "Se procesó correctamente la petición"
                }
            ]
        }
    }
}

Ejemplo Extorno Exitoso

JSON
{
    "success": "true",
    "merchant_code": "abc",
    "operation": {
        "merchant_operation_number": "8522366",
        "amount": "150",
        "currency": "604",
        "created_at": {
            "utc_time": "2024-07-05T20:34:18",
            "unix_time": 1720211658.876
        },
        "state": "EXTORNADO",
        "transactions": [
            {
                "transaction_id": "0fuwnd6miwsomisn0ikqivav9",
                "state": "EXTORNADO",
                "state_reason": "Pago anulado",
                "amount": "150",
                "currency": "604",
                "additional_fields": null,
                "payment_method": {
                    "method_name": "CARD",
                    "method_detail": {
                        "redirect_url": null,
                        "callback_url": null,
                        "masked_pan": "545545******3401",
                        "brand": "MASTERCARD",
                        "bin": "545545",
                        "last_pan": "3401",
                        "card_type": "CIRRUS",
                        "card_country": "PE",
                        "issuer": "SCOTIABANK PERU S.A.A."
                    }
                },
                "continue_url": null,
                "expiration_date": null,
                "risk_evaluation": null,
                "authentication_result": null,
                "processor_response": {
                    "reverse_date": "05-07-2024 20:34:19",
                    "reverse_code": "T90261",
                    "brand_transaction_id": "0705203422939657",
                    "result_message": {
                        "code": "00",
                        "description": "Aprobado"
                    }
                },
                "lifecycle": [
                    {
                        "state": "REGISTRADO",
                        "date": {
                            "utc_time": "2024-07-05T20:34:18",
                            "unix_time": 1720211658.893
                        }
                    },
                    {
                        "state": "PENDIENTE",
                        "date": {
                            "utc_time": "2024-07-05T20:34:19",
                            "unix_time": 1720211659.261
                        }
                    },
                    {
                        "state": "AUTORIZADO",
                        "date": {
                            "utc_time": "2024-07-05T20:34:24",
                            "unix_time": 1720211664.054
                        }
                    },
                    {
                        "state": "EXTORNADO",
                        "date": {
                            "utc_time": "2024-07-05T21:34:24",
                            "unix_time": 1720211664.054
                        }
                    }
                ]
            }
        ]
    },
    "meta": {
        "status": {
            "code": "00",
            "message_ilgn": [
                {
                    "locale": "es_PE",
                    "value": "Se procesó correctamente la petición"
                }
            ]
        }
    }
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.