Saltar a contenido

API de django-payments-chile

Este documento proporciona una visión general de los diferentes proveedores de pago disponibles en django-payments-chile. Cada proveedor tiene su propia implementación y configuración específica.

Para obtener detalles sobre cada proveedor, consulte los siguientes enlaces:

Cada enlace lo llevará a una documentación detallada sobre la implementación y uso de ese proveedor específico.

FlowProvider

El FlowProvider es una implementación para integrar la pasarela de pagos Flow en django-payments-chile.

Métodos principales

  • __init__(self, **kwargs): Inicializa el proveedor con las configuraciones necesarias.
  • get_form(self, payment, data=None): Retorna el formulario para iniciar el proceso de pago.
  • process_data(self, payment, request): Procesa los datos recibidos de Flow después de un pago.

Configuración

Para utilizar FlowProvider, añada la siguiente configuración a PAYMENT_VARIANTS en su archivo settings.py:

PAYMENT_VARIANTS = {
    "flow": ("django_payments_chile.FlowProvider", {
        "api_key": "su_api_key",
        "api_secret": "su_api_secret",
        "api_endpoint": "sandbox",  # Cambie a "live" para producción
        "api_medio": 9,  # 9 indica todos los medios de pago
    })
}

Uso

Para crear un pago utilizando FlowProvider:

from django_payments import get_payment_model

Payment = get_payment_model()
payment = Payment.objects.create(
    variant='flow',  # Debe coincidir con la clave en PAYMENT_VARIANTS
    amount=1000,
    currency='CLP',
    description='Descripción del pago'
)

Consulte la documentación de Flow para más detalles sobre la integración y opciones disponibles.

API

FlowProvider

Bases: BasicProvider

FlowProvider es una clase que proporciona integración con Flow para procesar pagos. Inicializa una instancia de FlowProvider con el key y el secreto de Flow.

Parameters:

Name Type Description Default
api_key str

ApiKey entregada por Flow.

 required
api_secret str

ApiSecret entregada por Flow.

 required
api_medio int | None

Versión de la API de notificaciones a utilizar (Valor por defecto: 9).

 9
api_endpoint str

Ambiente flow, puede ser "live" o "sandbox" (Valor por defecto: live).

 required
**kwargs int

Argumentos adicionales.

 {}
Source code in django_payments_chile/FlowProvider.py 
 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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
class FlowProvider(BasicProvider):
    """
    FlowProvider es una clase que proporciona integración con Flow para procesar pagos.
    Inicializa una instancia de FlowProvider con el key y el secreto de Flow.

    Args:
        api_key (str): ApiKey entregada por Flow.
        api_secret (str): ApiSecret entregada por Flow.
        api_medio (int | None): Versión de la API de notificaciones a utilizar (Valor por defecto: 9).
        api_endpoint (str): Ambiente flow, puede ser "live" o "sandbox" (Valor por defecto: live).
        **kwargs: Argumentos adicionales.
    """

    form_class = BasePaymentForm
    api_endpoint: str
    api_key: str = None
    api_secret: str = None
    api_medio: int
    _client: Any = None

    def __init__(
        self,
        api_endpoint: str,
        api_key: str,
        api_secret: str,
        api_medio: int = 9,
        **kwargs: int,
    ):
        super().__init__(**kwargs)
        self.api_endpoint = api_endpoint
        self.api_key = api_key
        self.api_secret = api_secret
        self.api_medio = api_medio
        if self.api_endpoint == "live":
            self.api_endpoint = "https://www.flow.cl/api"
        elif self.api_endpoint == "sandbox":
            self.api_endpoint = "https://sandbox.flow.cl/api"
        self._client = ApiClient(self.api_endpoint, self.api_key, self.api_secret)

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

        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 Flow.

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

        """
        if not payment.transaction_id:
            datos_para_flow = {
                "apiKey": self.api_key,
                "commerceOrder": payment.token,
                "urlReturn": payment.get_success_url(),
                "urlConfirmation": f"{get_base_url()}{payment.get_process_url()}",
                "subject": payment.description,
                "amount": int(payment.total),
                "paymentMethod": self.api_medio,
                "currency": payment.currency,
            }

            if payment.billing_email:
                datos_para_flow.update({"email": payment.billing_email})

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

            try:
                payment.attrs.datos_payment_create_flow = datos_para_flow
                payment.save()
            except Exception as e:
                raise PaymentError(f"Ocurrió un error al guardar attrs.datos_flow: {e}")

            try:
                pago = FlowPayment.create(self._client, datos_para_flow)

            except Exception as pe:
                payment.change_status(PaymentStatus.ERROR, str(pe))
                raise PaymentError(pe)
            else:
                payment.transaction_id = pago.token
                payment.attrs.respuesta_flow = {
                    "url": pago.url,
                    "token": pago.token,
                    "flowOrder": pago.flowOrder,
                }
                payment.save()
                payment.change_status(PaymentStatus.WAITING)

            raise RedirectNeeded(f"{pago.url}?token={pago.token}")

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

        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 "token" not in request.POST:
            raise HttpResponseBadRequest("token no está en post")

        data = {"status": "ok"}
        if payment.status in [PaymentStatus.WAITING, PaymentStatus.PREAUTH]:
            self.actualiza_estado(payment=payment)

        return JsonResponse(data)

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

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

        Returns:
            dict: Diccionario con valores del objeto `PaymentStatus`.
        """
        try:
            status = FlowPayment.getStatus(self._client, payment.transaction_id)
        except Exception as e:
            raise e
        else:
            if status.status == 2:
                payment.change_status(PaymentStatus.CONFIRMED)
            elif status.status == 3:
                payment.change_status(PaymentStatus.REJECTED)
            elif status.status == 4:
                payment.change_status(PaymentStatus.ERROR)
        return asdict(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 = [
            "commerceOrder",
            "urlReturn",
            "urlConfirmation",
            "amount",
            "subject",
            "paymentMethod",
            "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 Flow

        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
        try:
            datos_reembolso = {
                "apiKey": self.api_key,
                "refundCommerceOrder": payment.token,
                "receiverEmail": payment.billing_email,
                "amount": to_refund,
                "urlCallBack": f"{get_base_url()}{payment.get_process_url()}",
                "commerceTrxId": payment.token,
                "flowTrxId": payment.attrs.respuesta_flow["flowOrder"],
            }
            refund = FlowRefund.create(self._client, datos_reembolso)
        except Exception as pe:
            raise PaymentError(pe)
        else:
            payment.attrs.solicitud_reembolso = refund
            payment.save()
            payment.change_status(PaymentStatus.REFUNDED)
            return to_refund

    def capture(self):
        """
        Captura el pago (no implementado).

        Note:
            Método no soportado por Flow.
        Raises:
            NotImplementedError: Método no implementado.
        """
        raise NotImplementedError()

    def release(self):
        """
        Libera el pago (no implementado).

        Note:
            Método no soportado por Flow.

        Raises:
            NotImplementedError: Método no implementado.

        """
        raise NotImplementedError()

actualiza_estado(payment)

Actualiza el estado del pago con Flow

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/FlowProvider.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def actualiza_estado(self, payment) -> dict:
    """Actualiza el estado del pago con Flow

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

    Returns:
        dict: Diccionario con valores del objeto `PaymentStatus`.
    """
    try:
        status = FlowPayment.getStatus(self._client, payment.transaction_id)
    except Exception as e:
        raise e
    else:
        if status.status == 2:
            payment.change_status(PaymentStatus.CONFIRMED)
        elif status.status == 3:
            payment.change_status(PaymentStatus.REJECTED)
        elif status.status == 4:
            payment.change_status(PaymentStatus.ERROR)
    return asdict(status)

capture()

Captura el pago (no implementado).

Note

Método no soportado por Flow.

Raises: NotImplementedError: Método no implementado.

Source code in django_payments_chile/FlowProvider.py 
219
220
221
222
223
224
225
226
227
228
def capture(self):
    """
    Captura el pago (no implementado).

    Note:
        Método no soportado por Flow.
    Raises:
        NotImplementedError: Método no implementado.
    """
    raise NotImplementedError()

get_form(payment, data=None)

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

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 Flow.

Raises:

Type Description
RedirectNeeded

Redirige a la página de pago de Flow.
Source code in django_payments_chile/FlowProvider.py 
 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
def get_form(self, payment, data: Optional[dict] = None) -> Any:
    """
    Genera el formulario de pago para redirigir a la página de pago de Flow.

    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 Flow.

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

    """
    if not payment.transaction_id:
        datos_para_flow = {
            "apiKey": self.api_key,
            "commerceOrder": payment.token,
            "urlReturn": payment.get_success_url(),
            "urlConfirmation": f"{get_base_url()}{payment.get_process_url()}",
            "subject": payment.description,
            "amount": int(payment.total),
            "paymentMethod": self.api_medio,
            "currency": payment.currency,
        }

        if payment.billing_email:
            datos_para_flow.update({"email": payment.billing_email})

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

        try:
            payment.attrs.datos_payment_create_flow = datos_para_flow
            payment.save()
        except Exception as e:
            raise PaymentError(f"Ocurrió un error al guardar attrs.datos_flow: {e}")

        try:
            pago = FlowPayment.create(self._client, datos_para_flow)

        except Exception as pe:
            payment.change_status(PaymentStatus.ERROR, str(pe))
            raise PaymentError(pe)
        else:
            payment.transaction_id = pago.token
            payment.attrs.respuesta_flow = {
                "url": pago.url,
                "token": pago.token,
                "flowOrder": pago.flowOrder,
            }
            payment.save()
            payment.change_status(PaymentStatus.WAITING)

        raise RedirectNeeded(f"{pago.url}?token={pago.token}")

process_data(payment, request)

Procesa los datos del pago recibidos desde Flow.

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/FlowProvider.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def process_data(self, payment, request) -> JsonResponse:
    """
    Procesa los datos del pago recibidos desde Flow.

    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 "token" not in request.POST:
        raise HttpResponseBadRequest("token no está en post")

    data = {"status": "ok"}
    if payment.status in [PaymentStatus.WAITING, PaymentStatus.PREAUTH]:
        self.actualiza_estado(payment=payment)

    return JsonResponse(data)

refund(payment, amount=None)

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

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/FlowProvider.py 
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
208
209
210
211
212
213
214
215
216
217
def refund(self, payment, amount: Optional[int] = None) -> int:
    """
    Realiza un reembolso del pago.
    El seguimiendo se debe hacer directamente en Flow

    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
    try:
        datos_reembolso = {
            "apiKey": self.api_key,
            "refundCommerceOrder": payment.token,
            "receiverEmail": payment.billing_email,
            "amount": to_refund,
            "urlCallBack": f"{get_base_url()}{payment.get_process_url()}",
            "commerceTrxId": payment.token,
            "flowTrxId": payment.attrs.respuesta_flow["flowOrder"],
        }
        refund = FlowRefund.create(self._client, datos_reembolso)
    except Exception as pe:
        raise PaymentError(pe)
    else:
        payment.attrs.solicitud_reembolso = refund
        payment.save()
        payment.change_status(PaymentStatus.REFUNDED)
        return to_refund

release()

Libera el pago (no implementado).

Note

Método no soportado por Flow.

Raises:

Type Description
NotImplementedError

Método no implementado.
Source code in django_payments_chile/FlowProvider.py 
230
231
232
233
234
235
236
237
238
239
240
241
def release(self):
    """
    Libera el pago (no implementado).

    Note:
        Método no soportado por Flow.

    Raises:
        NotImplementedError: Método no implementado.

    """
    raise NotImplementedError()