Saltar a contenido

KhipuProvider

KhipuProvider

Bases: BasicProvider

KhipuProvider es una clase que proporciona integración con Khipu para procesar pagos. Inicializa una instancia de KhipuProvider con la nueva llave de api introducida en v3

Parameters:

Name Type Description Default
api_key str

ApiKey entregada por Khipu.

 required
**kwargs int

Argumentos adicionales.

 {}
Source code in django_payments_chile/KhipuProvider.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
class KhipuProvider(BasicProvider):
    """
    KhipuProvider es una clase que proporciona integración con Khipu para procesar pagos.
    Inicializa una instancia de KhipuProvider con la nueva llave de api introducida en v3

    Args:
        api_key (str): ApiKey entregada por Khipu.
        **kwargs: Argumentos adicionales.
    """

    form_class = BasePaymentForm
    api_endpoint: str = "https://payment-api.khipu.com"
    api_key: str = None

    def __init__(
        self,
        api_key: str,
        api_endpoint: str,
        **kwargs: int,
    ):
        super().__init__(**kwargs)
        self.api_endpoint = api_endpoint
        self.api_key = api_key

    def get_form(self, payment, data: Optional[dict] = None) -> Any:
        """
        Genera el formulario de pago para redirigir a la página de pago de Khipu.

        Args:
            payment ("Payment"): Objeto de pago Django Payments.
            data (dict | None): Datos del formulario (opcional).

        Returns:
            Any: Formulario de pago redirigido a la página de pago de Khipu.

        Raises:
            RedirectNeeded: Redirige a la página de pago de Khipu.

        """
        if not payment.transaction_id:
            datos_para_khipu = {
                "transaction_id": str(payment.token),
                "return_url": payment.get_success_url(),
                "notify_url": payment.get_process_url(),
                "subject": payment.description,
                "amount": Decimal(payment.total),
                "currency": payment.currency,
            }

            if payment.billing_email:
                datos_para_khipu.update({"payer_email": payment.billing_email})

            datos_para_khipu.update(**self._extra_data(payment.attrs))

            payment.attrs.datos_payment_create = datos_para_khipu
            payment.save()

            try:
                pago_req = requests.post(
                    f"{self.api_endpoint}/v3/payments",
                    data=datos_para_khipu,
                    timeout=5,
                    headers=self.genera_headers(),
                )
                pago_req.raise_for_status()

            except Exception as pe:
                payment.change_status(PaymentStatus.ERROR, str(pe))
                raise PaymentError(pe)
            else:
                pago = pago_req.json()
                payment.transaction_id = pago["payment_id"]
                payment.attrs.respuesta_khipu = {
                    "payment_id": pago["payment_id"],
                    "payment_url": pago["payment_url"],
                    "simplified_transfer_url": pago["simplified_transfer_url"],
                    "transfer_url": pago["transfer_url"],
                    "app_url": pago["app_url"],
                    "ready_for_terminal": pago["ready_for_terminal"],
                }
                payment.save()
                payment.change_status(PaymentStatus.WAITING)

            raise RedirectNeeded(f"{pago['payment_url']}")

    def genera_headers(self):
        return {"Content-Type": "application/json", "x-api-key": self.api_key}

    def process_data(self, payment, request) -> JsonResponse:
        """
        Procesa los datos del pago recibidos desde Khipu.

        Args:
            payment ("Payment"): Objeto de pago Django Payments.
            request ("HttpRequest"): Objeto de solicitud HTTP de Django.

        Returns:
            JsonResponse: Respuesta JSON que indica el procesamiento de los datos del pago.

        """
        if "transaction_id" not in request.POST:
            return HttpResponseBadRequest("transaction_id no está en post")

        if payment.status in [PaymentStatus.WAITING, PaymentStatus.PREAUTH]:
            self.actualiza_estado(payment=payment)

        return JsonResponse({"status": "ok"})

    def actualiza_estado(self, payment) -> dict:
        """Actualiza el estado del pago con Khipu

        Args:
            payment ("Payment): Objeto de pago Django Payments.

        Returns:
            dict: Diccionario con valores del objeto `PaymentStatus`.
        """
        try:
            estado_req = requests.get(
                f"{self.api_endpoint}/v3/payments/{payment.token}",
                timeout=5,
                headers=self.genera_headers(),
            )
            estado_req.raise_for_status()

        except Exception as e:
            raise e
        else:
            status = estado_req.json()
            if status["status"] == "done" and status["status_detail"] == "normal":
                payment.change_status(PaymentStatus.CONFIRMED)
            elif status["status_detail"] in ["rejected-by-payer", "reversed", "marked-as-abuse"]:
                payment.change_status(PaymentStatus.REJECTED)
        return status

    def _extra_data(self, attrs) -> dict:
        """Busca los datos que son enviandos por django-payments y los saca del diccionario

        Args:
            attrs ("PaymentAttributeProxy"): Obtenido desde PaymentModel.extra_data

        Returns:
            dict: Diccionario con valores permitidos.
        """
        try:
            data = attrs.datos_extra
        except AttributeError:
            return {}

        prohibidos = [
            "amount",
            "subject",
            "currency",
        ]
        for valor in prohibidos:
            if valor in data:
                del data[valor]

        return data

    def refund(self, payment, amount: Optional[int] = None) -> int:
        """
        Realiza un reembolso del pago.
        El seguimiendo se debe hacer directamente en Khipu

        Args:
            payment ("Payment"): Objeto de pago Django Payments.
            amount (int | None): Monto a reembolsar (opcional).

        Returns:
            int: Monto de reembolso solicitado.

        Raises:
            PaymentError: Error al crear el reembolso.

        """
        if payment.status != PaymentStatus.CONFIRMED:
            raise PaymentError("El pago debe estar confirmado para reversarse.")

        to_refund = amount or payment.total

        datos_reembolso = {"amount": to_refund}
        try:
            refun_req = requests.post(
                f"{self.api_endpoint}/v3/payments/{payment.token}/refunds",
                data=datos_reembolso,
                timeout=5,
                headers=self.genera_headers(),
            )
            refun_req.raise_for_status()
        except Exception as pe:
            raise PaymentError(pe)
        else:
            payment.attrs.solicitud_reembolso = refun_req.json()
            payment.save()
            payment.change_status(PaymentStatus.REFUNDED)
            return to_refund

actualiza_estado(payment)

Actualiza el estado del pago con Khipu

Parameters:

Name Type Description Default
payment "Payment

Objeto de pago Django Payments.

 required

Returns:

Name Type Description
dict dict

Diccionario con valores del objeto PaymentStatus.
Source code in django_payments_chile/KhipuProvider.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def actualiza_estado(self, payment) -> dict:
    """Actualiza el estado del pago con Khipu

    Args:
        payment ("Payment): Objeto de pago Django Payments.

    Returns:
        dict: Diccionario con valores del objeto `PaymentStatus`.
    """
    try:
        estado_req = requests.get(
            f"{self.api_endpoint}/v3/payments/{payment.token}",
            timeout=5,
            headers=self.genera_headers(),
        )
        estado_req.raise_for_status()

    except Exception as e:
        raise e
    else:
        status = estado_req.json()
        if status["status"] == "done" and status["status_detail"] == "normal":
            payment.change_status(PaymentStatus.CONFIRMED)
        elif status["status_detail"] in ["rejected-by-payer", "reversed", "marked-as-abuse"]:
            payment.change_status(PaymentStatus.REJECTED)
    return status

get_form(payment, data=None)

Genera el formulario de pago para redirigir a la página de pago de Khipu.

Parameters:

Name Type Description Default
payment Payment

Objeto de pago Django Payments.

 required
data dict | None

Datos del formulario (opcional).

 None

Returns:

Name Type Description
Any Any

Formulario de pago redirigido a la página de pago de Khipu.

Raises:

Type Description
RedirectNeeded

Redirige a la página de pago de Khipu.
Source code in django_payments_chile/KhipuProvider.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
def get_form(self, payment, data: Optional[dict] = None) -> Any:
    """
    Genera el formulario de pago para redirigir a la página de pago de Khipu.

    Args:
        payment ("Payment"): Objeto de pago Django Payments.
        data (dict | None): Datos del formulario (opcional).

    Returns:
        Any: Formulario de pago redirigido a la página de pago de Khipu.

    Raises:
        RedirectNeeded: Redirige a la página de pago de Khipu.

    """
    if not payment.transaction_id:
        datos_para_khipu = {
            "transaction_id": str(payment.token),
            "return_url": payment.get_success_url(),
            "notify_url": payment.get_process_url(),
            "subject": payment.description,
            "amount": Decimal(payment.total),
            "currency": payment.currency,
        }

        if payment.billing_email:
            datos_para_khipu.update({"payer_email": payment.billing_email})

        datos_para_khipu.update(**self._extra_data(payment.attrs))

        payment.attrs.datos_payment_create = datos_para_khipu
        payment.save()

        try:
            pago_req = requests.post(
                f"{self.api_endpoint}/v3/payments",
                data=datos_para_khipu,
                timeout=5,
                headers=self.genera_headers(),
            )
            pago_req.raise_for_status()

        except Exception as pe:
            payment.change_status(PaymentStatus.ERROR, str(pe))
            raise PaymentError(pe)
        else:
            pago = pago_req.json()
            payment.transaction_id = pago["payment_id"]
            payment.attrs.respuesta_khipu = {
                "payment_id": pago["payment_id"],
                "payment_url": pago["payment_url"],
                "simplified_transfer_url": pago["simplified_transfer_url"],
                "transfer_url": pago["transfer_url"],
                "app_url": pago["app_url"],
                "ready_for_terminal": pago["ready_for_terminal"],
            }
            payment.save()
            payment.change_status(PaymentStatus.WAITING)

        raise RedirectNeeded(f"{pago['payment_url']}")

process_data(payment, request)

Procesa los datos del pago recibidos desde Khipu.

Parameters:

Name Type Description Default
payment Payment

Objeto de pago Django Payments.

 required
request HttpRequest

Objeto de solicitud HTTP de Django.

 required

Returns:

Name Type Description
JsonResponse JsonResponse

Respuesta JSON que indica el procesamiento de los datos del pago.
Source code in django_payments_chile/KhipuProvider.py 
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
def process_data(self, payment, request) -> JsonResponse:
    """
    Procesa los datos del pago recibidos desde Khipu.

    Args:
        payment ("Payment"): Objeto de pago Django Payments.
        request ("HttpRequest"): Objeto de solicitud HTTP de Django.

    Returns:
        JsonResponse: Respuesta JSON que indica el procesamiento de los datos del pago.

    """
    if "transaction_id" not in request.POST:
        return HttpResponseBadRequest("transaction_id no está en post")

    if payment.status in [PaymentStatus.WAITING, PaymentStatus.PREAUTH]:
        self.actualiza_estado(payment=payment)

    return JsonResponse({"status": "ok"})

refund(payment, amount=None)

Realiza un reembolso del pago. El seguimiendo se debe hacer directamente en Khipu

Parameters:

Name Type Description Default
payment Payment

Objeto de pago Django Payments.

 required
amount int | None

Monto a reembolsar (opcional).

 None

Returns:

Name Type Description
int int

Monto de reembolso solicitado.

Raises:

Type Description
PaymentError

Error al crear el reembolso.
Source code in django_payments_chile/KhipuProvider.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
def refund(self, payment, amount: Optional[int] = None) -> int:
    """
    Realiza un reembolso del pago.
    El seguimiendo se debe hacer directamente en Khipu

    Args:
        payment ("Payment"): Objeto de pago Django Payments.
        amount (int | None): Monto a reembolsar (opcional).

    Returns:
        int: Monto de reembolso solicitado.

    Raises:
        PaymentError: Error al crear el reembolso.

    """
    if payment.status != PaymentStatus.CONFIRMED:
        raise PaymentError("El pago debe estar confirmado para reversarse.")

    to_refund = amount or payment.total

    datos_reembolso = {"amount": to_refund}
    try:
        refun_req = requests.post(
            f"{self.api_endpoint}/v3/payments/{payment.token}/refunds",
            data=datos_reembolso,
            timeout=5,
            headers=self.genera_headers(),
        )
        refun_req.raise_for_status()
    except Exception as pe:
        raise PaymentError(pe)
    else:
        payment.attrs.solicitud_reembolso = refun_req.json()
        payment.save()
        payment.change_status(PaymentStatus.REFUNDED)
        return to_refund