Saltar a contenido

Payment

La clase Payment proporciona métodos para interactuar con la API de pagos de Flow.cl. Permite realizar operaciones como obtener el estado de un pago, obtener una lista de pagos, crear un nuevo pago y crear un pago por correo electrónico.

Metodos

create(apiclient, payment_data)

Este método permite crear una orden de pago a Flow y recibe como respuesta la URL para redirigir el browser del pagador y el token que identifica la transacción. La url de redirección se debe formar concatenando los valores recibidos en la respuesta de la siguiente forma:

url + "?token=" +token

Una vez que el pagador efectúe el pago, Flow notificará el resultado a la página del comercio que se envió en el parámetro urlConfirmation.

Source code in pyflowcl/Payment.py
Python
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
def create(apiclient: ApiClient, payment_data: dict[str, Any]) -> PaymentResponse:
    """
    Este método permite crear una orden de pago a Flow y recibe como respuesta
    la URL para redirigir el browser del pagador y el token que identifica la
    transacción. La url de redirección se debe formar concatenando los valores
    recibidos en la respuesta de la siguiente forma:

    url + "?token=" +token

    Una vez que el pagador efectúe el pago, Flow notificará el resultado a la
    página del comercio que se envió en el parámetro urlConfirmation.

    """
    url = f"{apiclient.api_url}/payment/create"
    payment = PaymentRequest.from_dict(payment_data)
    if not payment.apiKey:
        payment.apiKey = apiclient.api_key
    payment.s = apiclient.make_signature(asdict(payment))
    response = apiclient.post(url, asdict(payment))
    if response.status_code == 200:
        return PaymentResponse.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})

createEmail(apiclient, payment_data)

Permite generar un cobro por email. Flow emite un email al pagador que contiene la información de la Orden de pago y el link de pago correspondiente. Una vez que el pagador efectúe el pago, Flow notificará el resultado a la página del comercio que se envió en el parámetro urlConfirmation.

Source code in pyflowcl/Payment.py
Python
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def createEmail(apiclient: ApiClient, payment_data: dict[str, Any]) -> PaymentResponse:
    """
    Permite generar un cobro por email. Flow emite un email al pagador
    que contiene la información de la Orden de pago y el link de pago
    correspondiente. Una vez que el pagador efectúe el pago, Flow
    notificará el resultado a la página del comercio que se envió en el
    parámetro urlConfirmation.
    """
    url = f"{apiclient.api_url}/payment/createEmail"
    payment = PaymentRequestEmail.from_dict(payment_data)
    if payment.apiKey is None:
        payment.apiKey = apiclient.api_key

    payment.s = apiclient.make_signature(asdict(payment))
    response = apiclient.post(url, asdict(payment))

    if response.status_code == 200:
        return PaymentResponse.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})

getPayments(apiclient, payment_info)

Este método permite obtener la lista paginada de pagos recibidos en un día.Los objetos pagos de la lista tienen la misma estructura de los retornados en los servicios payment/getStatus

Source code in pyflowcl/Payment.py
Python
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def getPayments(apiclient: ApiClient, payment_info: dict[str, Any]) -> PaymentList:
    """
    Este método permite obtener la lista paginada de pagos recibidos en
    un día.Los objetos pagos de la lista tienen la misma estructura de
    los retornados en los servicios payment/getStatus
    """
    url = f"{apiclient.api_url}/payment/getPayments"

    payment_info["apiKey"] = apiclient.api_key
    signature = apiclient.make_signature(payment_info)
    payment_info["s"] = signature
    response = apiclient.get(url, payment_info)

    if response.status_code == 200:
        return PaymentList.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})

getStatus(apiclient, token)

Obtiene el estado de un pago previamente creado, el parametro token hace referencia a notification id, el cual se recibe luego de procesado un pago

Parameters:

Name Type Description Default
apiclient ApiClient

ApiClient

 required
token str

str

 required

Returns:

Type Description
PaymentStatus

PaymentStatus
Source code in pyflowcl/Payment.py
Python
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
def getStatus(apiclient: ApiClient, token: str) -> PaymentStatus:
    """
    Obtiene el estado de un pago previamente creado, el parametro token
    hace referencia a notification id, el cual se recibe luego de procesado
    un pago

    Args:
        apiclient: ApiClient
        token: str

    Returns:
        PaymentStatus
    """
    url = f"{apiclient.api_url}/payment/getStatus"

    params: dict[str, Any] = {"apiKey": apiclient.api_key, "token": token}
    signature = apiclient.make_signature(params)
    params["s"] = signature
    response = apiclient.get(url, params)

    if response.status_code == 200:
        return PaymentStatus.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})

getStatusByCommerceId(apiclient, commerceId)

Obtiene el estado de un pago previamente creado, el parametro token hace referencia a notification id, el cual se recibe luego de procesado un pago

Source code in pyflowcl/Payment.py
Python
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def getStatusByCommerceId(apiclient: ApiClient, commerceId: str) -> PaymentStatus:
    """
    Obtiene el estado de un pago previamente creado, el parametro token
    hace referencia a notification id, el cual se recibe luego de procesado
    un pago
    """
    url = f"{apiclient.api_url}/payment/getStatusByCommerceId"

    params: dict[str, Any] = {"apiKey": apiclient.api_key, "commerceId": commerceId}
    signature = apiclient.make_signature(params)
    params["s"] = signature
    response = apiclient.get(url, params)

    if response.status_code == 200:
        return PaymentStatus.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})

getStatusByFlowOrder(apiclient, flowOrder)

Obtiene el estado de un pago previamente creado, el parametro token hace referencia a notification id, el cual se recibe luego de procesado un pago

Source code in pyflowcl/Payment.py
Python
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def getStatusByFlowOrder(apiclient: ApiClient, flowOrder: int) -> PaymentStatus:
    """
    Obtiene el estado de un pago previamente creado, el parametro token
    hace referencia a notification id, el cual se recibe luego de procesado
    un pago
    """
    url = f"{apiclient.api_url}/payment/getStatusByFlowOrder"

    params: dict[str, Any] = {"apiKey": apiclient.api_key, "flowOrder": flowOrder}
    signature = apiclient.make_signature(params)
    params["s"] = signature
    response = apiclient.get(url, params)

    if response.status_code == 200:
        return PaymentStatus.from_dict(cast(dict[str, Any], response.json()))
    elif response.status_code == 400:
        raise GenericError(cast(dict[str, Any], response.json()))
    elif response.status_code == 401:
        raise GenericError(cast(dict[str, Any], response.json()))
    else:
        raise GenericError({"code": response.status_code, "message": response})