Saltar a contenido

Documentación API

Banks

Bases: APIResource[T]

Source code in khipu_tools/_banks.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class Banks(APIResource[T]):
    OBJECT_NAME: ClassVar[Literal["banks"]] = "banks"
    OBJECT_PREFIX: ClassVar[Literal["v3"]] = "v3"

    banks: list[BankItem]
    """Listado con Bancos registrados"""

    @classmethod
    def get(cls) -> KhipuObject["Banks"]:
        """
        Este método obtiene la lista de bancos que se pueden utilizar para pagar en esta cuenta de cobro.
        """
        result = cls._static_request(
            "get",
            cls.class_url(),
        )
        if not isinstance(result, KhipuObject):
            raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

        return result

banks instance-attribute

Listado con Bancos registrados

get() classmethod

Este método obtiene la lista de bancos que se pueden utilizar para pagar en esta cuenta de cobro.

Source code in khipu_tools/_banks.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
@classmethod
def get(cls) -> KhipuObject["Banks"]:
    """
    Este método obtiene la lista de bancos que se pueden utilizar para pagar en esta cuenta de cobro.
    """
    result = cls._static_request(
        "get",
        cls.class_url(),
    )
    if not isinstance(result, KhipuObject):
        raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

    return result

BankItem

Informacion de banco

Source code in khipu_tools/_banks.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class BankItem:
    """
    Informacion de banco
    """

    bank_id: str
    """Identificador del banco."""
    name: str
    """Nombre del banco."""
    message: str
    """Mensaje con particularidades del banco."""
    min_amount: int
    """Monto mínimo que acepta el banco en un pago"""
    type: Literal["Persona", "Empresa"]
    """Tipo de banco."""
    parent: str
    """Identificador del banco padre (si un banco tiene banca personas y empresas, el primero será el padre del segundo)."""
    logo_url: str
    """URL del logo del banco."""

bank_id instance-attribute

Identificador del banco.

logo_url instance-attribute

URL del logo del banco.

message instance-attribute

Mensaje con particularidades del banco.

min_amount instance-attribute

Monto mínimo que acepta el banco en un pago

name instance-attribute

Nombre del banco.

parent instance-attribute

Identificador del banco padre (si un banco tiene banca personas y empresas, el primero será el padre del segundo).

type instance-attribute

Tipo de banco.

Predict

Bases: APIResource[T]

Source code in khipu_tools/_predict.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
class Predict(APIResource[T]):
    OBJECT_NAME: ClassVar[Literal["predict"]] = "predict"
    OBJECT_PREFIX: ClassVar[Literal["v3"]] = "v3"

    class PredictParams(RequestOptions):
        payer_email: str
        """Correo electrónico del pagador"""
        bank_id: str
        """Identificador del banco de origen"""
        amount: str
        """Monto del pago"""
        currency: str
        """Moneda en formato ISO-4217"""

    result: Literal[
        "ok",
        "new_destinatary_amount_exceeded",
        "max_amount_exceeded",
        "new_destinatary_cool_down",
        "not_available_account",
    ]
    """El resultado de la predicción."""
    max_amount: int
    """El monto máximo posible para transferir."""
    cool_down_date: str
    """Fecha de término para la restricción de monto en formato ISO-8601"""
    new_destinatary_max_amount: str
    """Monto máximo para transferir a un nuevo destinatario."""

    @classmethod
    def get(cls, **params: Unpack["Predict.PredictParams"]) -> KhipuObject["Predict"]:
        """
        Predicción acerca del resultado de un pago, si podrá o no funcionar.
        Información adicional como máximo posible de transferir a un nuevo destinatario.
        """
        result = cls._static_request(
            "get",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, KhipuObject):
            raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

        return result

cool_down_date instance-attribute

Fecha de término para la restricción de monto en formato ISO-8601

max_amount instance-attribute

El monto máximo posible para transferir.

new_destinatary_max_amount instance-attribute

Monto máximo para transferir a un nuevo destinatario.

result instance-attribute

El resultado de la predicción.

PredictParams

Bases: RequestOptions

Source code in khipu_tools/_predict.py 
17
18
19
20
21
22
23
24
25
class PredictParams(RequestOptions):
    payer_email: str
    """Correo electrónico del pagador"""
    bank_id: str
    """Identificador del banco de origen"""
    amount: str
    """Monto del pago"""
    currency: str
    """Moneda en formato ISO-4217"""

amount instance-attribute

Monto del pago

bank_id instance-attribute

Identificador del banco de origen

currency instance-attribute

Moneda en formato ISO-4217

payer_email instance-attribute

Correo electrónico del pagador

get(**params) classmethod

Predicción acerca del resultado de un pago, si podrá o no funcionar. Información adicional como máximo posible de transferir a un nuevo destinatario.

Source code in khipu_tools/_predict.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@classmethod
def get(cls, **params: Unpack["Predict.PredictParams"]) -> KhipuObject["Predict"]:
    """
    Predicción acerca del resultado de un pago, si podrá o no funcionar.
    Información adicional como máximo posible de transferir a un nuevo destinatario.
    """
    result = cls._static_request(
        "get",
        cls.class_url(),
        params=params,
    )
    if not isinstance(result, KhipuObject):
        raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

    return result

Payments

Bases: APIResource[T]

Source code in khipu_tools/_payments.py 
 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
class Payments(APIResource[T]):
    OBJECT_NAME: ClassVar[Literal["Payment"]] = "payments"
    OBJECT_PREFIX: ClassVar[Literal["v3"]] = "v3"

    class PaymentParams(RequestOptions):
        """
        Parametros de creacion de pago
        """

        amount: str
        """ El monto del cobro. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda. """
        currency: Literal["CLP", "CLF", "ARS", "PEN", "MXN", "USD", "EUR", "BOB", "COP"]
        """El código de moneda en formato ISO-4217."""
        subject: str
        """Motivo."""
        transaction_id: Optional[str]
        """Identificador propio de la transacción. Ej: número de factura u orden de compra."""
        custom: Optional[str]
        """Parámetro para enviar información personalizada de la transacción. Ej: documento XML con el detalle del carro de compra."""
        body: Optional[str]
        """Descripción del cobro."""
        bank_id: Optional[str]
        """Identificador del banco para usar en el pago."""
        return_url: Optional[str]
        """La dirección URL a donde enviar al cliente mientras el pago está siendo verificado."""
        cancel_url: Optional[str]
        """La dirección URL a donde enviar al cliente si decide no hacer hacer la transacción."""
        picture_url: Optional[str]
        """Una dirección URL de una foto de tu producto o servicio."""
        notify_url: Optional[str]
        """La dirección del web-service que utilizará khipu para notificar cuando el pago esté conciliado."""
        contract_url: Optional[str]
        """La dirección URL del archivo PDF con el contrato a firmar mediante este pago. El cobrador debe estar habilitado para este servicio y el campo fixed_payer_personal_identifier es obligatorio."""
        notify_api_version: Literal["3.0"]
        """Versión de la API de notificaciones para recibir avisos por web-service. Solo está soportada la version 3.0. para versiones anteriores pyeden usar la libreria pykhipu"""
        expires_date: Optional[str]
        """Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución."""
        send_email: Optional[bool]
        """Si es True, se enviará una solicitud de cobro al correo especificado en payer_email."""
        payer_name: Optional[str]
        """Nombre del pagador. Es obligatorio cuando send_email es true."""
        payer_email: Optional[str]
        """Correo del pagador. Es obligatorio cuando send_email es true."""
        send_reminders: Optional[bool]
        """Si es true, se enviarán recordatorios de cobro."""
        responsible_user_email: Optional[str]
        """Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro."""
        fixed_payer_personal_identifier: Optional[str]
        """Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador."""
        integrator_fee: Optional[str]
        """Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada."""
        collect_account_uuid: Optional[str]
        """Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia."""
        confirm_timeout_date: Optional[str]
        """Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601."""
        mandatory_payment_method: Optional[str]
        """El cobro sólo se podrá pagar utilizando el medio de pago especificado. Los posibles valores para este campo se encuentran en el campo id de la respuesta del endpoint /api/3.0/merchants/paymentMethods."""
        psp_client_merchant_name: Optional[str]
        """Nombre del comercio final para quien un proveedor de servicios de pago procesa un pago. Requerido para transacciones de clientes PSP; no aplicable para otros."""

    class PaymentCreateResponse(KhipuObject):
        payment_id: str
        """Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días)."""
        payment_url: str
        """URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones."""
        simplified_transfer_url: str
        """URL de pago simplificado."""
        transfer_url: str
        """URL de pago normal."""
        app_url: str
        """URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu."""
        ready_for_terminal: bool
        """Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu."""

    class PaymentInfo(RequestOptions):
        payment_id: str
        """Identificador del pago"""

    class PaymentRefundResponse(KhipuObject):
        message: str
        """Mensaje a desplegar al usuario."""

    payment_id: str
    """Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días)."""
    payment_url: str
    """URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones."""
    simplified_transfer_url: str
    """URL de pago simplificado."""
    transfer_url: str
    """URL de pago normal."""
    app_url: str
    """URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu."""
    ready_for_terminal: bool
    """Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu."""
    notification_token: str
    """Cadena de caracteres alfanuméricos que identifican unicamente al pago, es el identificador que el servidor de Khipu enviará al servidor del comercio cuando notifique que un pago está conciliado."""
    receiver_id: int
    """Identificador único de una cuenta de cobro."""
    conciliation_date: str
    """Fecha y hora de conciliación del pago. Formato ISO-8601."""
    subject: str
    """Motivo del pago."""
    amount: Decimal
    """El monto del cobro."""
    currency: str
    """El código de moneda en formato ISO-4217."""
    status: Literal["pending", "verifying", "done"]
    """Estado del pago, puede ser pending (el pagador aún no comienza a pagar), verifying (se está verificando el pago) o done, cuando el pago ya está confirmado."""
    status_detail: Literal[
        "pending",
        "normal",
        "marked-paid-by-receiver",
        "rejected-by-payer",
        "marked-as-abuse",
        "reversed",
    ]
    """Detalle del estado del pago: pending (el pagador aún no comienza a pagar), normal (el pago fue verificado y fue cancelado por algún medio de pago estándar), marked-paid-by-receiver (el cobrador marcó el cobro como pagado por otro medio), rejected-by-payer (el pagador declaró que no pagará), marked-as-abuse (el pagador declaró que no pagará y que el cobro fue no solicitado), y reversed (el pago fue anulado por el comercio, el dinero fue devuelto al pagador)."""
    body: str
    """Detalle del cobro."""
    picture_url: str
    """URL con imagen del cobro."""
    receipt_url: str
    """URL del comprobante de pago."""
    return_url: str
    """URL donde se redirige al pagador luego que termina el pago."""
    cancel_url: str
    """URL donde se redirige al pagador luego de que desiste hacer el pago."""
    notify_url: str
    """URL del webservice donde se notificará el pago."""
    notify_api_version: Literal["3,0"]
    """Versión de la API de notificación."""
    expires_date: str
    """Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución."""
    attachment_urls: list[str]
    """Arreglo de URLs de archivos adjuntos al pago."""
    bank: str
    """Nombre del banco seleccionado por el pagador."""
    bank_id: str
    """Identificador del banco seleccionado por el pagador."""
    payer_name: str
    """Nombre del pagador."""
    payer_email: str
    """Correo electrónico del pagador."""
    personal_identifier: str
    """Identificador personal del pagador."""
    bank_account_number: str
    """Número de cuenta bancaria del pagador."""
    out_of_date_conciliation: bool
    """Es true si la conciliación del pago fue hecha luego de la fecha de expiración."""
    transaction_id: str
    """Identificador del pago asignado por el cobrador."""
    custom: str
    """Campo genérico que asigna el cobrador al momento de hacer el pago."""
    responsible_user_email: str
    """Correo electrónico de la persona responsable del pago."""
    send_reminders: bool
    """Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios."""
    send_email: bool
    """Es true cuando Khipu enviará el cobro por correo electrónico."""
    payment_method: Literal["regular_transfer", "simplified_transfer", "not_available"]
    """Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada)."""
    funds_source: Literal["debit", "prepaid", "credit", "not-available", ""]
    """Origen de fondos usado por el pagador, puede ser debit para pago con débito, prepaid para pago con prepago, credit para pago con crédito, o vacío en el caso de que se haya pagado mediante transferencia bancaria."""
    discount: int
    """Monto a descontar del valor pagado."""
    third_party_authorization_details: str
    """Ignorar este campo."""

    @classmethod
    def create(cls, **params: Unpack["Payments.PaymentParams"]) -> KhipuObject["Payments.PaymentCreateResponse"]:
        """
        Crea un pago en Khipu y obtiene las URLs para redirección al usuario para que complete el pago.
        """
        result = cls._static_request(
            "post",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, KhipuObject):
            raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

        return result

    @classmethod
    def get(cls, **params: Unpack["Payments.PaymentInfo"]) -> KhipuObject["Payments"]:
        """
        Información completa del pago. Datos con los que fue creado y el estado actual del pago.
        """
        result = cls._static_request(
            "get",
            f"{cls.class_url()}/{params['payment_id']}",
        )
        if not isinstance(result, KhipuObject):
            raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

        return result

    @classmethod
    def delete(cls, **params: Unpack["Payments.PaymentInfo"]) -> bool:
        """
        Borrar un pago. Solo se pueden borrar pagos que estén pendientes de pagar. Esta operación no puede deshacerse.
        """
        result = cls._static_request(
            "delete",
            f"{cls.class_url()}/{params['payment_id']}",
        )

        return result

    @classmethod
    def refund(cls, **params: Unpack["Payments.PaymentInfo"]) -> KhipuObject["Payments.PaymentRefundResponse"]:
        """
        Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que
        recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes.
        """
        result = cls._static_request(
            "post",
            f"{cls.class_url()}/{params['payment_id']}/refunds",
            params=params,
        )
        if not isinstance(result, KhipuObject):
            raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

        return result

amount instance-attribute

El monto del cobro.

app_url instance-attribute

URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.

attachment_urls instance-attribute

Arreglo de URLs de archivos adjuntos al pago.

bank instance-attribute

Nombre del banco seleccionado por el pagador.

bank_account_number instance-attribute

Número de cuenta bancaria del pagador.

bank_id instance-attribute

Identificador del banco seleccionado por el pagador.

body instance-attribute

Detalle del cobro.

cancel_url instance-attribute

URL donde se redirige al pagador luego de que desiste hacer el pago.

conciliation_date instance-attribute

Fecha y hora de conciliación del pago. Formato ISO-8601.

currency instance-attribute

El código de moneda en formato ISO-4217.

custom instance-attribute

Campo genérico que asigna el cobrador al momento de hacer el pago.

discount instance-attribute

Monto a descontar del valor pagado.

expires_date instance-attribute

Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.

funds_source instance-attribute

Origen de fondos usado por el pagador, puede ser debit para pago con débito, prepaid para pago con prepago, credit para pago con crédito, o vacío en el caso de que se haya pagado mediante transferencia bancaria.

notification_token instance-attribute

Cadena de caracteres alfanuméricos que identifican unicamente al pago, es el identificador que el servidor de Khipu enviará al servidor del comercio cuando notifique que un pago está conciliado.

notify_api_version instance-attribute

Versión de la API de notificación.

notify_url instance-attribute

URL del webservice donde se notificará el pago.

out_of_date_conciliation instance-attribute

Es true si la conciliación del pago fue hecha luego de la fecha de expiración.

payer_email instance-attribute

Correo electrónico del pagador.

payer_name instance-attribute

Nombre del pagador.

payment_id instance-attribute

Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).

payment_method instance-attribute

Método de pago usado por el pagador, puede ser regular_transfer (transferencia normal) o simplified_transfer (transferencia simplificada).

payment_url instance-attribute

URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.

personal_identifier instance-attribute

Identificador personal del pagador.

picture_url instance-attribute

URL con imagen del cobro.

ready_for_terminal instance-attribute

Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.

receipt_url instance-attribute

URL del comprobante de pago.

receiver_id instance-attribute

Identificador único de una cuenta de cobro.

responsible_user_email instance-attribute

Correo electrónico de la persona responsable del pago.

return_url instance-attribute

URL donde se redirige al pagador luego que termina el pago.

send_email instance-attribute

Es true cuando Khipu enviará el cobro por correo electrónico.

send_reminders instance-attribute

Es true cuando este es un cobro por correo electrónico y Khipu enviará recordatorios.

simplified_transfer_url instance-attribute

URL de pago simplificado.

status instance-attribute

Estado del pago, puede ser pending (el pagador aún no comienza a pagar), verifying (se está verificando el pago) o done, cuando el pago ya está confirmado.

status_detail instance-attribute

Detalle del estado del pago: pending (el pagador aún no comienza a pagar), normal (el pago fue verificado y fue cancelado por algún medio de pago estándar), marked-paid-by-receiver (el cobrador marcó el cobro como pagado por otro medio), rejected-by-payer (el pagador declaró que no pagará), marked-as-abuse (el pagador declaró que no pagará y que el cobro fue no solicitado), y reversed (el pago fue anulado por el comercio, el dinero fue devuelto al pagador).

subject instance-attribute

Motivo del pago.

third_party_authorization_details instance-attribute

Ignorar este campo.

transaction_id instance-attribute

Identificador del pago asignado por el cobrador.

transfer_url instance-attribute

URL de pago normal.

PaymentCreateResponse

Bases: KhipuObject

Source code in khipu_tools/_payments.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
class PaymentCreateResponse(KhipuObject):
    payment_id: str
    """Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días)."""
    payment_url: str
    """URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones."""
    simplified_transfer_url: str
    """URL de pago simplificado."""
    transfer_url: str
    """URL de pago normal."""
    app_url: str
    """URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu."""
    ready_for_terminal: bool
    """Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu."""

app_url instance-attribute

URL para invocar el pago desde un dispositivo móvil usando la APP de Khipu.

payment_id instance-attribute

Identificador único del pago, es una cadena alfanumérica de 12 caracteres. Como este identificador es único, se puede usar, por ejemplo, para evitar procesar una notificación repetida. (Khipu espera un código 200 al notificar un pago, si esto no ocurre se reintenta hasta por dos días).

payment_url instance-attribute

URL principal del pago, si el usuario no ha elegido previamente un método de pago se le muestran las opciones.

ready_for_terminal instance-attribute

Es true si el pago ya cuenta con todos los datos necesarios para abrir directamente la aplicación de pagos Khipu.

simplified_transfer_url instance-attribute

URL de pago simplificado.

transfer_url instance-attribute

URL de pago normal.

PaymentInfo

Bases: RequestOptions

Source code in khipu_tools/_payments.py 
88
89
90
class PaymentInfo(RequestOptions):
    payment_id: str
    """Identificador del pago"""

payment_id instance-attribute

Identificador del pago

PaymentParams

Bases: RequestOptions

Parametros de creacion de pago

Source code in khipu_tools/_payments.py 
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
class PaymentParams(RequestOptions):
    """
    Parametros de creacion de pago
    """

    amount: str
    """ El monto del cobro. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda. """
    currency: Literal["CLP", "CLF", "ARS", "PEN", "MXN", "USD", "EUR", "BOB", "COP"]
    """El código de moneda en formato ISO-4217."""
    subject: str
    """Motivo."""
    transaction_id: Optional[str]
    """Identificador propio de la transacción. Ej: número de factura u orden de compra."""
    custom: Optional[str]
    """Parámetro para enviar información personalizada de la transacción. Ej: documento XML con el detalle del carro de compra."""
    body: Optional[str]
    """Descripción del cobro."""
    bank_id: Optional[str]
    """Identificador del banco para usar en el pago."""
    return_url: Optional[str]
    """La dirección URL a donde enviar al cliente mientras el pago está siendo verificado."""
    cancel_url: Optional[str]
    """La dirección URL a donde enviar al cliente si decide no hacer hacer la transacción."""
    picture_url: Optional[str]
    """Una dirección URL de una foto de tu producto o servicio."""
    notify_url: Optional[str]
    """La dirección del web-service que utilizará khipu para notificar cuando el pago esté conciliado."""
    contract_url: Optional[str]
    """La dirección URL del archivo PDF con el contrato a firmar mediante este pago. El cobrador debe estar habilitado para este servicio y el campo fixed_payer_personal_identifier es obligatorio."""
    notify_api_version: Literal["3.0"]
    """Versión de la API de notificaciones para recibir avisos por web-service. Solo está soportada la version 3.0. para versiones anteriores pyeden usar la libreria pykhipu"""
    expires_date: Optional[str]
    """Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución."""
    send_email: Optional[bool]
    """Si es True, se enviará una solicitud de cobro al correo especificado en payer_email."""
    payer_name: Optional[str]
    """Nombre del pagador. Es obligatorio cuando send_email es true."""
    payer_email: Optional[str]
    """Correo del pagador. Es obligatorio cuando send_email es true."""
    send_reminders: Optional[bool]
    """Si es true, se enviarán recordatorios de cobro."""
    responsible_user_email: Optional[str]
    """Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro."""
    fixed_payer_personal_identifier: Optional[str]
    """Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador."""
    integrator_fee: Optional[str]
    """Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada."""
    collect_account_uuid: Optional[str]
    """Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia."""
    confirm_timeout_date: Optional[str]
    """Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601."""
    mandatory_payment_method: Optional[str]
    """El cobro sólo se podrá pagar utilizando el medio de pago especificado. Los posibles valores para este campo se encuentran en el campo id de la respuesta del endpoint /api/3.0/merchants/paymentMethods."""
    psp_client_merchant_name: Optional[str]
    """Nombre del comercio final para quien un proveedor de servicios de pago procesa un pago. Requerido para transacciones de clientes PSP; no aplicable para otros."""

amount instance-attribute

El monto del cobro. Sin separador de miles y usando '.' como separador de decimales. Hasta 4 lugares decimales, dependiendo de la moneda.

bank_id instance-attribute

Identificador del banco para usar en el pago.

body instance-attribute

Descripción del cobro.

cancel_url instance-attribute

La dirección URL a donde enviar al cliente si decide no hacer hacer la transacción.

collect_account_uuid instance-attribute

Para cuentas de cobro con más cuenta propia. Permite elegir la cuenta donde debe ocurrir la transferencia.

confirm_timeout_date instance-attribute

Fecha de rendición del cobro. Es también la fecha final para poder reembolsar el cobro. Formato ISO-8601.

contract_url instance-attribute

La dirección URL del archivo PDF con el contrato a firmar mediante este pago. El cobrador debe estar habilitado para este servicio y el campo fixed_payer_personal_identifier es obligatorio.

currency instance-attribute

El código de moneda en formato ISO-4217.

custom instance-attribute

Parámetro para enviar información personalizada de la transacción. Ej: documento XML con el detalle del carro de compra.

expires_date instance-attribute

Fecha máxima para ejecutar el pago (en formato ISO-8601). El cliente podrá realizar varios intentos de pago hasta dicha fecha. Cada intento tiene un plazo individual de 3 horas para su ejecución.

fixed_payer_personal_identifier instance-attribute

Identificador personal. Si se especifica, solo podrá ser pagado usando ese identificador.

integrator_fee instance-attribute

Comisión para el integrador. Sólo es válido si la cuenta de cobro tiene una cuenta de integrador asociada.

mandatory_payment_method instance-attribute

El cobro sólo se podrá pagar utilizando el medio de pago especificado. Los posibles valores para este campo se encuentran en el campo id de la respuesta del endpoint /api/3.0/merchants/paymentMethods.

notify_api_version instance-attribute

Versión de la API de notificaciones para recibir avisos por web-service. Solo está soportada la version 3.0. para versiones anteriores pyeden usar la libreria pykhipu

notify_url instance-attribute

La dirección del web-service que utilizará khipu para notificar cuando el pago esté conciliado.

payer_email instance-attribute

Correo del pagador. Es obligatorio cuando send_email es true.

payer_name instance-attribute

Nombre del pagador. Es obligatorio cuando send_email es true.

picture_url instance-attribute

Una dirección URL de una foto de tu producto o servicio.

psp_client_merchant_name instance-attribute

Nombre del comercio final para quien un proveedor de servicios de pago procesa un pago. Requerido para transacciones de clientes PSP; no aplicable para otros.

responsible_user_email instance-attribute

Correo electrónico del responsable de este cobro, debe corresponder a un usuario Khipu con permisos para cobrar usando esta cuenta de cobro.

return_url instance-attribute

La dirección URL a donde enviar al cliente mientras el pago está siendo verificado.

send_email instance-attribute

Si es True, se enviará una solicitud de cobro al correo especificado en payer_email.

send_reminders instance-attribute

Si es true, se enviarán recordatorios de cobro.

subject instance-attribute

Motivo.

transaction_id instance-attribute

Identificador propio de la transacción. Ej: número de factura u orden de compra.

PaymentRefundResponse

Bases: KhipuObject

Source code in khipu_tools/_payments.py 
92
93
94
class PaymentRefundResponse(KhipuObject):
    message: str
    """Mensaje a desplegar al usuario."""

message instance-attribute

Mensaje a desplegar al usuario.

create(**params) classmethod

Crea un pago en Khipu y obtiene las URLs para redirección al usuario para que complete el pago.

Source code in khipu_tools/_payments.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
@classmethod
def create(cls, **params: Unpack["Payments.PaymentParams"]) -> KhipuObject["Payments.PaymentCreateResponse"]:
    """
    Crea un pago en Khipu y obtiene las URLs para redirección al usuario para que complete el pago.
    """
    result = cls._static_request(
        "post",
        cls.class_url(),
        params=params,
    )
    if not isinstance(result, KhipuObject):
        raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

    return result

delete(**params) classmethod

Borrar un pago. Solo se pueden borrar pagos que estén pendientes de pagar. Esta operación no puede deshacerse.

Source code in khipu_tools/_payments.py 
211
212
213
214
215
216
217
218
219
220
221
@classmethod
def delete(cls, **params: Unpack["Payments.PaymentInfo"]) -> bool:
    """
    Borrar un pago. Solo se pueden borrar pagos que estén pendientes de pagar. Esta operación no puede deshacerse.
    """
    result = cls._static_request(
        "delete",
        f"{cls.class_url()}/{params['payment_id']}",
    )

    return result

get(**params) classmethod

Información completa del pago. Datos con los que fue creado y el estado actual del pago.

Source code in khipu_tools/_payments.py 
197
198
199
200
201
202
203
204
205
206
207
208
209
@classmethod
def get(cls, **params: Unpack["Payments.PaymentInfo"]) -> KhipuObject["Payments"]:
    """
    Información completa del pago. Datos con los que fue creado y el estado actual del pago.
    """
    result = cls._static_request(
        "get",
        f"{cls.class_url()}/{params['payment_id']}",
    )
    if not isinstance(result, KhipuObject):
        raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

    return result

refund(**params) classmethod

Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes.

Source code in khipu_tools/_payments.py 
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
@classmethod
def refund(cls, **params: Unpack["Payments.PaymentInfo"]) -> KhipuObject["Payments.PaymentRefundResponse"]:
    """
    Reembolsa total o parcialmente el monto de un pago. Esta operación solo se puede realizar en los comercios que
    recauden en cuenta Khipu y antes de la rendición de los fondos correspondientes.
    """
    result = cls._static_request(
        "post",
        f"{cls.class_url()}/{params['payment_id']}/refunds",
        params=params,
    )
    if not isinstance(result, KhipuObject):
        raise TypeError("Expected KhipuObject object from API, got %s" % (type(result).__name__))

    return result