wire4_client 0.0.1.pre.SNAPSHOT → 0.0.9.pre.TEST

data/docs/MessageAccountBeneficiary.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**account** | **String** | Cuenta del beneficiario | [optional] 
+**account** | **String** | Cuenta del beneficiario registrado | [optional] 
 **error_message** | **String** | Mensaje de error en caso de existir, el valor de este atributo contiene el mensaje | [optional] 
-**request_id** | **String** | El identificador, en esta API, de la petición de registro de la cuenta del beneficiario | [optional] 
+**request_id** | **String** | El identificador en esta API, de la petición de registro de la cuenta del beneficiario | [optional] 
 
 

data/docs/MessageCEP.md

@@ -6,23 +6,23 @@ Name | Type | Description | Notes
 **account_beneficiary** | **String** | Cuenta del beneficiario | [optional] 
 **account_sender** | **String** | Cuenta que envia la operación | [optional] 
 **amount** | **Float** | Monto de la operación | [optional] 
-**available** | **BOOLEAN** | Bander para saber si el cep esta disponible | [optional] 
+**available** | **BOOLEAN** | Indica sí el CEP está disponible | [optional] 
 **bank_beneficiary** | **String** | Clave del banco beneficiario | [optional] 
-**bank_sender** | **String** | Clave del banco que envia la operación | [optional] 
+**bank_sender** | **String** | Clave del banco que envía la operación | [optional] 
 **beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
 **beneficiary_rfc** | **String** | RFC del beneficiario | [optional] 
 **cadena_original** | **String** | Cadena original emita por el SAT | [optional] 
 **capture_date** | **DateTime** | Fecha de captura | [optional] 
-**certificate_serial_number** | **String** | Numero de serie emitido por el SAT | [optional] 
+**certificate_serial_number** | **String** | Número de serie emitido por el SAT | [optional] 
 **clave_rastreo** | **String** | Clave de rastreo de la operación | [optional] 
 **description** | **String** | Descripción de la operación | [optional] 
-**iva** | **Float** | Iva de la operación | [optional] 
+**iva** | **Float** | IVA de la operación | [optional] 
 **operation_date** | **DateTime** | Fecha en la que se realizó la operación | [optional] 
-**operation_date_cep** | **DateTime** | Fecha en la que genera el cep | [optional] 
+**operation_date_cep** | **DateTime** | Fecha en la que genera el CEP | [optional] 
 **reference** | **String** | Referencia de la operación | [optional] 
-**sender_name** | **String** | Nombre de quien envia la operación | [optional] 
-**sender_rfc** | **String** | RFC de quien envia la operación | [optional] 
-**signature** | **String** | Firma del Cep | [optional] 
-**url_zip** | **String** | Url que contiene el PDF y XML del CEP proporcionado por banxico | [optional] 
+**sender_name** | **String** | Nombre de quién envía la operación | [optional] 
+**sender_rfc** | **String** | RFC de quién envía la operación | [optional] 
+**signature** | **String** | Firma del CEP | [optional] 
+**url_zip** | **String** | Dirección URL de descarga del archivo ZIP que contiene el PDF y XML del CEP proporcionado por BANXICO | [optional] 
 
 

data/docs/MessageCodiAction.md

@@ -0,0 +1,19 @@
+# Wire4Client::MessageCodiAction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto de la operación de pago | [optional] 
+**concept** | **String** | Concepto | [optional] 
+**due_date** | **DateTime** | Fecha de expiración de la operación | [optional] 
+**id** | **String** | Uuid de la operación | [optional] 
+**metadata** | **String** | Metadata asociada a la petición de pago | [optional] 
+**operation_date** | **DateTime** | Fecha de la operación | [optional] 
+**order_id** | **String** | Identificador de la petición | [optional] 
+**payment_type** | **String** | Tipo de pago | [optional] 
+**reference** | **String** | Número de referencia | [optional] 
+**sales_point_id** | **String** | Identidicador del punto de venta a la que pertenece la petición de pago | [optional] 
+**status** | **String** | Estado de la operación de pago | [optional] 
+**transaction_id** | **String** | Id de la transacción | [optional] 
+
+

data/docs/MessageConfigurationsLimits.md

@@ -0,0 +1,8 @@
+# Wire4Client::MessageConfigurationsLimits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**configurations** | [**Array<ConfigurationsLimits>**](ConfigurationsLimits.md) | Lista de configuraciones pertenecientes al contrato | [optional] 
+
+

data/docs/MessageDepositAuthorizationRequest.md

@@ -0,0 +1,27 @@
+# Wire4Client::MessageDepositAuthorizationRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto de la transferencia | [optional] 
+**beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
+**beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
+**beneficiary_rfc** | **String** | RFC del beneficiario | [optional] 
+**clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
+**confirm_date** | **DateTime** | Fecha de confirmación de la transferencia | [optional] 
+**currency_code** | **String** | Código de moneda de la transferencia, puede ser MXP, USD | [optional] 
+**deposit_date** | **DateTime** | Fecha de recepción de la transferencia | [optional] 
+**depositant** | **String** | Nombre del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_clabe** | **String** | CLABE del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_email** | **String** | Correo electrónico del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**depositant_rfc** | **String** | RFC del depositante, en caso que la transferencia se reciba en una cuenta de depositante | [optional] 
+**description** | **String** | Concepto de la transferencia | [optional] 
+**monex_description** | **String** | Descripción de Monex para la transferencia | [optional] 
+**monex_transaction_id** | **String** | Identificador asignado por Monex a la transferencia | [optional] 
+**reference** | **String** | Referecia de la transferencia | [optional] 
+**sender_account** | **String** | Cuenta del ordenante, podría ser un número celular, TDD o Cuenta CLABE interbancaria | [optional] 
+**sender_bank** | [**MessageInstitution**](MessageInstitution.md) | Información del banco del ordenante | [optional] 
+**sender_name** | **String** | Nombre del ordenante | [optional] 
+**sender_rfc** | **String** | RFC del ordenante | [optional] 
+
+

data/docs/MessageDepositReceived.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
 **beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
 **beneficiary_rfc** | **String** | RFC del beneficiario | [optional] 
+**cep** | [**MessageCEP**](MessageCEP.md) | Informacion del CEP | [optional] 
 **clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
 **confirm_date** | **DateTime** | Fecha de confirmación de la transferencia | [optional] 
 **currency_code** | **String** | Código de moneda de la transferencia, puede ser MXP, USD | [optional] 

data/docs/MessagePayment.md

@@ -8,15 +8,17 @@ Name | Type | Description | Notes
 **beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
 **beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional] 
 **beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
-**cep** | [**MessageCEP**](MessageCEP.md) |  | [optional] 
+**cep** | [**MessageCEP**](MessageCEP.md) | Informacion del CEP | [optional] 
 **clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
 **concept** | **String** | Concepto de la transferencia de salida | [optional] 
 **confirm_date** | **DateTime** | Fecha de confirmación de la transferencia de salida | [optional] 
 **currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional] 
 **detention_message** | **String** | Mensaje de detención de Monex de la transferencia de salida | [optional] 
+**error_message** | **String** | Mensaje de error | [optional] 
 **monex_description** | **String** | La descripción de Monex de la transferencia de salida | [optional] 
 **order_id** | **String** | El identificador de la transferencia de salida | [optional] 
 **payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional] 
+**pending_reason** | **String** | Razón de porque está pendiente aún cuando se autorizó la transferencia | [optional] 
 **reference** | **Integer** | Referecia de la transferencia | [optional] 
 **request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional] 
 **status_code** | **String** | El estado de la transferencia de salida | [optional] 

data/docs/MessagePaymentStatePending.md

@@ -0,0 +1,23 @@
+# Wire4Client::MessagePaymentStatePending
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | Cuenta del ordenante | [optional] 
+**amount** | **Float** | Monto de la transferencia | [optional] 
+**beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
+**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional] 
+**beneficiary_name** | **String** | Nombre del beneficiario | [optional] 
+**concept** | **String** | Concepto de la transferencia de salida | [optional] 
+**currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional] 
+**detention_message** | **String** | Mensaje de detención de Monex, indica la causa por la cuál esta detenida la operación en Monex | [optional] 
+**error_message** | **String** | Mensaje de error | [optional] 
+**order_id** | **String** | El identificador de la transferencia de salida | [optional] 
+**payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional] 
+**pending_reason** | **String** | Estatus que identifica la causa por la que la transferencia esta en pendiente, los posibles estatus son: FI=Fondos Insuficientes | FM=Firma mancomunada, en espera de ingreso de segundo token de autorización | DP=Se detecto una transferencia duplicada que esta en espera de confirmación o de eliminación | [optional] 
+**reference** | **Integer** | Referecia de la transferencia | [optional] 
+**request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional] 
+**status_code** | **String** | El estado de la transferencia de salida, deberá ser PENDING | [optional] 
+**transaction_id** | **Integer** | El identificador de Monex de la transferencia de salida, podría no estar presente por lo que Usted debería hacer referencias mediate el paymentOrderID | [optional] 
+
+

data/docs/MessageRequestChanged.md

@@ -0,0 +1,9 @@
+# Wire4Client::MessageRequestChanged
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | Identificador de la petición realizada a esta API | [optional] 
+**status** | **String** | El cambio a informar en la procesamiento/estado de la petición | [optional] 
+
+

data/docs/MessageSalesPoint.md

@@ -0,0 +1,10 @@
+# Wire4Client::MessageSalesPoint
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | Cuenta donde se realziaran los pagos | [optional] 
+**ip** | **String** | Ip desde la cual se accedera al API | [optional] 
+**name** | **String** | Nombre del punto de venta | [optional] 
+
+

data/docs/MessageSubscription.md

@@ -3,10 +3,11 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**contract** | **String** | Contrato Monex, con el cual se suscribió el cliente Monex en Wire4 | [optional] 
-**subscription** | **String** | Identificador de la suscripción, el cual se utiliza en las operaciones que solicitan una suscripción | [optional] 
-**user** | **String** | Usuario enmascardo, con el cual se suscribió el cliente Monex en Wire4 | [optional] 
-**user_key** | **String** | Usuario proporcionado por Wire4, el cual se debe utilizar para autenticar a esta suscripción | [optional] 
-**user_secret** | **String** | Contraseña proporcionada por Wire4, la cual se debe utilizar para autenticar a esta suscripción | [optional] 
+**contract** | **String** | Contrato Monex, con el cuál se suscribió el cliente Monex en Wire4 | [optional] 
+**masked_contract** | **String** | Contrato enmascarado de Monex, con el cuál se suscribió el cliente Monex en Wire4 | [optional] 
+**subscription** | **String** | Identificador de la suscripción, el cual se utilizará en las operaciones que solicitan una suscripción | [optional] 
+**user** | **String** | Usuario enmascardo, con el cuál se suscribió el cliente Monex en Wire4 | [optional] 
+**user_key** | **String** | Usuario proporcionado por Wire4, el cuál se debe utilizar para autenticar a esta suscripción | [optional] 
+**user_secret** | **String** | Contraseña proporcionada por Wire4, la cuál se debe utilizar para autenticar a esta suscripción | [optional] 
 
 

data/docs/MessageUserAuthorized.md

@@ -0,0 +1,14 @@
+# Wire4Client::MessageUserAuthorized
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | **String** | El contrato al cual se le brinda el acceso a la API | [optional] 
+**masked_account** | **String** | El contrato enmascarado al cual se le brinda el acceso a la API | [optional] 
+**masked_name** | **String** | El usuario enmascarado que se autorizó | [optional] 
+**masked_user_name** | **String** | El nombre enmascarado del usuario de acceso que se autorizó | [optional] 
+**name** | **String** | El usuario que se autorizó | [optional] 
+**request_id** | **String** | El identificador de la petición cuando se solicitó la autorización | [optional] 
+**user_name** | **String** | El nombre del usuario de acceso que se autorizó | [optional] 
+
+

data/docs/MessageWebHook.md

@@ -3,12 +3,12 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**api_version** | **String** | La versión de la API | [optional] 
+**api_version** | **String** | La versión de esta API | [optional] 
 **created** | **DateTime** | Fecha de creación del mensaje | [optional] 
 **data** | **Object** | Objeto que contiene la información del evento | [optional] 
 **id** | **String** | El identificador del mensaje | [optional] 
 **livemode** | **BOOLEAN** | Indica si proviene de un entorno productivo | [optional] 
-**object** | **String** | Tipo de objeto  que contiene el mensaje en el atributo data los posibles valores son: subscription, beneficiary, spei_outgoing, spei_incoming, spid_outgoing  | [optional] 
+**object** | **String** | Tipo de objeto  que contiene el mensaje en el atributo 'data' los posibles valores son: subscription, beneficiary, spei_outgoing, spei_incoming, spid_outgoing, request_outgoing  | [optional] 
 **pending_webhooks** | **Integer** | Número de  mensajes pendientes de enviar | [optional] 
 **request** | **String** | Identificador del recurso relacionado | [optional] 
 **type** | **String** | El tipo evento que se esta enviando en la notifiación | [optional] 

data/docs/OperacionesCoDiApi.md

@@ -0,0 +1,68 @@
+# Wire4Client::OperacionesCoDiApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**consult_codi_operations**](OperacionesCoDiApi.md#consult_codi_operations) | **POST** /codi/charges | Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
+
+
+# **consult_codi_operations**
+> PagerResponseDto consult_codi_operations(authorization, opts)
+
+Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
+
+Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::OperacionesCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+opts = { 
+  company_id: 'company_id_example', # String | Identificador de empresa CoDi
+  page: '0', # String | Número de pago
+  request_filters: Wire4Client::CodiOperationsFiltersRequestDTO.new, # CodiOperationsFiltersRequestDTO | Filtros de busqueda
+  sales_point_id: 'sales_point_id_example', # String | Identificador del punto de venta
+  size: '20' # String | Tamaño de pagina
+}
+
+begin
+  #Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
+  result = api_instance.consult_codi_operations(authorization, opts)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling OperacionesCoDiApi->consult_codi_operations: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **company_id** | **String**| Identificador de empresa CoDi | [optional] 
+ **page** | **String**| Número de pago | [optional] [default to 0]
+ **request_filters** | [**CodiOperationsFiltersRequestDTO**](CodiOperationsFiltersRequestDTO.md)| Filtros de busqueda | [optional] 
+ **sales_point_id** | **String**| Identificador del punto de venta | [optional] 
+ **size** | **String**| Tamaño de pagina | [optional] [default to 20]
+
+### Return type
+
+[**PagerResponseDto**](PagerResponseDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Operations.md

@@ -0,0 +1,17 @@
+# Wire4Client::Operations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto de la petición | [optional] 
+**company** | [**Compay**](Compay.md) | Empresa CoDi | [optional] 
+**description** | **String** | Descripción de la petición | [optional] 
+**due_date** | **DateTime** | Fecha de vencimiento de la petición | [optional] 
+**order_id** | **String** | Order id de la petición | [optional] 
+**payment** | [**PaymentCODI**](PaymentCODI.md) | Pago | [optional] 
+**phone_number** | **String** | Numero de telefono | [optional] 
+**sales_point** | [**SalesPoint**](SalesPoint.md) | Punto de venta | [optional] 
+**status** | **String** | Estatus de la petición | [optional] 
+**type** | **String** | Tipo de petición de cobro | [optional] 
+
+

data/docs/PagerResponseDto.md

@@ -0,0 +1,13 @@
+# Wire4Client::PagerResponseDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | [**Array<Operations>**](Operations.md) | Contenido de la respuesta paginada | [optional] 
+**number_of_elements** | **Integer** | Numero de elementos en la pagina | [optional] 
+**page** | **Integer** | Número de pagina | [optional] 
+**size** | **Integer** | Tamaño de la pagina | [optional] 
+**total_items** | **Integer** | Numero total de elementos de la consulta | [optional] 
+**total_pages** | **Integer** | Numero total de paginas | [optional] 
+
+

data/docs/Payment.md

@@ -6,17 +6,19 @@ Name | Type | Description | Notes
 **account** | **String** | Cuenta emisora | [optional] 
 **amount** | **Float** | Monto de la transferencia | [optional] 
 **beneficiary_account** | **String** | Cuenta del beneficiario | [optional] 
-**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Información del banco beneficiario | [optional] 
+**beneficiary_bank** | [**Institution**](Institution.md) | Información del banco beneficiario | [optional] 
 **beneficiary_name** | **String** | Nombre del Beneficiario | [optional] 
-**cep** | [**MessageCEP**](MessageCEP.md) | CEP emitido por Banxico de la transferencia, sólo en caso de que este disponible en banxico, posteriomente  podrá usar la consulta de CEP del API | [optional] 
+**cep** | [**MessageCEP**](MessageCEP.md) | CEP emitido por Banxico de la transferencia, sólo en caso de que este disponible en Banxico, posteriomente podrá usar la consulta de CEP del API | [optional] 
 **clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional] 
 **concept** | **String** | Concepto de pago | [optional] 
 **confirm_date** | **DateTime** | Fecha de aplicación de la transferencia | [optional] 
 **currency_code** | **String** | Código de moneda de la transferencia | [optional] 
 **detention_message** | **String** | Mensaje proporcionado por Monex para la transferencia | [optional] 
+**error_message** | **String** | Mensaje de error, en caso de algún error se informará aquí | [optional] 
 **monex_description** | **String** | Descripción | [optional] 
 **order_id** | **String** | Identificador asignado por la aplciación a la transferencia | [optional] 
 **payment_order_id** | **Integer** | Identificador de la orden de pago en Monex | [optional] 
+**pending_reason** | **String** | Razón de porque esta pendiente aun cuando se autorizó la transferencia | [optional] 
 **reference** | **Integer** | Referencia numérica | [optional] 
 **status_code** | **String** | Estado de la transferencia de la transferencia, los posibles valores son: PENDING, COMPLETED, FAILED, CANCELLED | [optional] 
 **transaction_id** | **Integer** | Identificador de la transferencia asignado por Monex | [optional] 

data/docs/PaymentCODI.md

@@ -0,0 +1,13 @@
+# Wire4Client::PaymentCODI
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto del pago | [optional] 
+**description** | **String** | Descripción del pago | [optional] 
+**error_message** | **String** | Mensaje de error | [optional] 
+**id** | **String** | Identificador del pago | [optional] 
+**operation_date** | **DateTime** | Fecha en que se efectuo el pago | [optional] 
+**status** | **String** | Estatus del pago | [optional] 
+
+

data/docs/PaymentRequestCodiResponseDTO.md

@@ -0,0 +1,18 @@
+# Wire4Client::PaymentRequestCodiResponseDTO
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Monto del pago. | [optional] 
+**barcode_base64** | **String** | Imagen QR en formato Base64 para el CODI®. | [optional] 
+**barcode_url** | **String** | URL de la imagen QR para el CODI®. | [optional] 
+**concept** | **String** | Concepto de pago. | [optional] 
+**creation_date** | **DateTime** | Fecha de creación. | [optional] 
+**due_date** | **DateTime** | Fecha de vencimiento. | [optional] 
+**operations** | [**Array<CodiOperationResponseDTO>**](CodiOperationResponseDTO.md) | Listado de pagos realizados sobre la petición. | [optional] 
+**order_id** | **String** | OrderId asignada a la solicitud. | [optional] 
+**phone_number** | **String** | Numero de teléfono. | [optional] 
+**status** | **String** | Estatus de la orden de pago. | [optional] 
+**type** | **String** | Tipo de petición. | [optional] 
+
+

data/docs/PaymentsRequestId.md

@@ -0,0 +1,13 @@
+# Wire4Client::PaymentsRequestId
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authorization_date** | **DateTime** | Fecha en que el usuario propietario del token emitió la autorización | [optional] 
+**request_date** | **DateTime** | Fecha en que se realizó la petición de registro de transacciones | [optional] 
+**request_id** | **String** | Identificador de la petición del registro de transacciones | [optional] 
+**total_amount** | **Float** | Monto total de las transacciones registradas | [optional] 
+**total_transactions** | **Integer** | Total de transacciones en la petición | [optional] 
+**transactions** | [**Array<Payment>**](Payment.md) | Lista de las transacciones registradas | [optional] 
+
+

data/docs/PeticionesDePagoPorCoDiApi.md

@@ -0,0 +1,116 @@
+# Wire4Client::PeticionesDePagoPorCoDiApi
+
+All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**consult_codi_request_by_order_id**](PeticionesDePagoPorCoDiApi.md#consult_codi_request_by_order_id) | **GET** /codi/sales-point/charges | Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+[**generate_codi_code_qr**](PeticionesDePagoPorCoDiApi.md#generate_codi_code_qr) | **POST** /codi/sales-point/charges | Genera un código QR para un pago mediante CODI®
+
+
+# **consult_codi_request_by_order_id**
+> PaymentRequestCodiResponseDTO consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
+
+Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+
+Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+order_id = 'order_id_example' # String | Identificador del pago CODI®
+
+sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
+
+
+begin
+  #Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
+  result = api_instance.consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PeticionesDePagoPorCoDiApi->consult_codi_request_by_order_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **order_id** | **String**| Identificador del pago CODI® | 
+ **sales_point_id** | **String**| Identificador del punto de venta | 
+
+### Return type
+
+[**PaymentRequestCodiResponseDTO**](PaymentRequestCodiResponseDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **generate_codi_code_qr**
+> CodiCodeQrResponseDTO generate_codi_code_qr(authorization, codi_info, sales_point_id)
+
+Genera un código QR para un pago mediante CODI®
+
+Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
+
+### Example
+```ruby
+# load the gem
+require 'wire4_client'
+
+api_instance = Wire4Client::PeticionesDePagoPorCoDiApi.new
+
+authorization = 'authorization_example' # String | Header para token
+
+codi_info = Wire4Client::CodiCodeRequestDTO.new # CodiCodeRequestDTO | Información del pago CODI®
+
+sales_point_id = 'sales_point_id_example' # String | Identificador del punto de venta
+
+
+begin
+  #Genera un código QR para un pago mediante CODI®
+  result = api_instance.generate_codi_code_qr(authorization, codi_info, sales_point_id)
+  p result
+rescue Wire4Client::ApiError => e
+  puts "Exception when calling PeticionesDePagoPorCoDiApi->generate_codi_code_qr: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Header para token | 
+ **codi_info** | [**CodiCodeRequestDTO**](CodiCodeRequestDTO.md)| Información del pago CODI® | 
+ **sales_point_id** | **String**| Identificador del punto de venta | 
+
+### Return type
+
+[**CodiCodeQrResponseDTO**](CodiCodeQrResponseDTO.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+