wire4_client 1.1.2 → 1.1.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (120) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +27 -0
  4. data/docs/AccountReassigned.md +1 -1
  5. data/docs/AccountResponse.md +1 -0
  6. data/docs/BeneficiaryDTO.md +10 -0
  7. data/docs/CargosRecurrentesApi.md +110 -0
  8. data/docs/CepResponse.md +1 -0
  9. data/docs/CepSearchBanxico.md +1 -0
  10. data/docs/CertificateRequest.md +1 -1
  11. data/docs/CodiCodeQrResponseDTO.md +1 -0
  12. data/docs/CodiCodeRequestDTO.md +6 -3
  13. data/docs/ConfirmRecurringCharge.md +9 -0
  14. data/docs/CuentasDeBeneficiariosSPEIApi.md +4 -0
  15. data/docs/CuentasDeBeneficiariosSPIDApi.md +4 -0
  16. data/docs/Customer.md +9 -0
  17. data/docs/Deposit.md +1 -0
  18. data/docs/Depositant.md +1 -0
  19. data/docs/DepositantCountResponse.md +8 -0
  20. data/docs/DepositantesApi.md +164 -1
  21. data/docs/FailedChargesDataDTO.md +13 -0
  22. data/docs/MessageDepositReceived.md +3 -0
  23. data/docs/PaymentRequestReportDTO.md +17 -0
  24. data/docs/PaymentRequestReq.md +18 -0
  25. data/docs/PaymentRequestResponse.md +10 -0
  26. data/docs/PaymentsSpeiAndSpidOrderId.md +9 -0
  27. data/docs/PaymentsSpeiAndSpidRequestId.md +12 -0
  28. data/docs/Person.md +1 -1
  29. data/docs/Product.md +11 -0
  30. data/docs/RecurringChargeRequest.md +14 -0
  31. data/docs/ReporteDeSolicitudesDePagosApi.md +107 -0
  32. data/docs/SolicitudDePagosApi.md +59 -0
  33. data/docs/SpidBeneficiaryResponse.md +1 -0
  34. data/docs/SuccessChargesDataDTO.md +12 -0
  35. data/docs/SuccessDataDTO.md +9 -0
  36. data/docs/TransactionSpeiSpid.md +15 -0
  37. data/docs/TransactionsRegister.md +11 -0
  38. data/docs/TransferenciasSPEIApi.md +163 -0
  39. data/lib/wire4_client/api/cargos_recurrentes_api.rb +143 -0
  40. data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +6 -0
  41. data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +6 -0
  42. data/lib/wire4_client/api/depositantes_api.rb +207 -2
  43. data/lib/wire4_client/api/reporte_de_solicitudes_de_pagos_api.rb +134 -0
  44. data/lib/wire4_client/api/solicitud_de_pagos_api.rb +84 -0
  45. data/lib/wire4_client/api/transferencias_spei_api.rb +234 -4
  46. data/lib/wire4_client/models/account_reassigned.rb +11 -11
  47. data/lib/wire4_client/models/account_response.rb +11 -1
  48. data/lib/wire4_client/models/amount_request.rb +10 -10
  49. data/lib/wire4_client/models/beneficiary_dto.rb +201 -0
  50. data/lib/wire4_client/models/cep_response.rb +45 -1
  51. data/lib/wire4_client/models/cep_search_banxico.rb +48 -4
  52. data/lib/wire4_client/models/certificate_request.rb +6 -15
  53. data/lib/wire4_client/models/codi_code_qr_response_dto.rb +15 -5
  54. data/lib/wire4_client/models/codi_code_request_dto.rb +94 -20
  55. data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +2 -2
  56. data/lib/wire4_client/models/confirm_recurring_charge.rb +194 -0
  57. data/lib/wire4_client/models/customer.rb +205 -0
  58. data/lib/wire4_client/models/deposit.rb +48 -4
  59. data/lib/wire4_client/models/depositant.rb +14 -4
  60. data/lib/wire4_client/models/depositant_count_response.rb +185 -0
  61. data/lib/wire4_client/models/failed_charges_data_dto.rb +228 -0
  62. data/lib/wire4_client/models/message_deposit_received.rb +31 -1
  63. data/lib/wire4_client/models/operations.rb +4 -4
  64. data/lib/wire4_client/models/payment_codi.rb +2 -2
  65. data/lib/wire4_client/models/payment_request_report_dto.rb +300 -0
  66. data/lib/wire4_client/models/payment_request_req.rb +401 -0
  67. data/lib/wire4_client/models/payment_request_response.rb +204 -0
  68. data/lib/wire4_client/models/payments_spei_and_spid_order_id.rb +199 -0
  69. data/lib/wire4_client/models/payments_spei_and_spid_request_id.rb +229 -0
  70. data/lib/wire4_client/models/person.rb +0 -5
  71. data/lib/wire4_client/models/product.rb +288 -0
  72. data/lib/wire4_client/models/recurring_charge_request.rb +278 -0
  73. data/lib/wire4_client/models/sales_point_request.rb +5 -5
  74. data/lib/wire4_client/models/spid_beneficiary_response.rb +11 -1
  75. data/lib/wire4_client/models/success_charges_data_dto.rb +219 -0
  76. data/lib/wire4_client/models/success_data_dto.rb +226 -0
  77. data/lib/wire4_client/models/transaction_outgoing.rb +5 -5
  78. data/lib/wire4_client/models/transaction_spei_spid.rb +390 -0
  79. data/lib/wire4_client/models/transactions_register.rb +229 -0
  80. data/lib/wire4_client/version.rb +1 -1
  81. data/lib/wire4_client.rb +19 -0
  82. data/spec/api/cargos_recurrentes_api_spec.rb +61 -0
  83. data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +2 -0
  84. data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +2 -0
  85. data/spec/api/depositantes_api_spec.rb +42 -1
  86. data/spec/api/reporte_de_solicitudes_de_pagos_api_spec.rb +59 -0
  87. data/spec/api/solicitud_de_pagos_api_spec.rb +48 -0
  88. data/spec/api/transferencias_spei_api_spec.rb +42 -0
  89. data/spec/models/account_reassigned_spec.rb +3 -3
  90. data/spec/models/account_response_spec.rb +6 -0
  91. data/spec/models/beneficiary_dto_spec.rb +53 -0
  92. data/spec/models/cep_response_spec.rb +10 -0
  93. data/spec/models/cep_search_banxico_spec.rb +10 -0
  94. data/spec/models/codi_code_qr_response_dto_spec.rb +8 -2
  95. data/spec/models/codi_code_request_dto_spec.rb +23 -1
  96. data/spec/models/codi_operations_filters_request_dto_spec.rb +1 -1
  97. data/spec/models/confirm_recurring_charge_spec.rb +47 -0
  98. data/spec/models/customer_spec.rb +47 -0
  99. data/spec/models/deposit_spec.rb +10 -0
  100. data/spec/models/depositant_count_response_spec.rb +41 -0
  101. data/spec/models/depositant_spec.rb +6 -0
  102. data/spec/models/failed_charges_data_dto_spec.rb +71 -0
  103. data/spec/models/message_deposit_received_spec.rb +18 -0
  104. data/spec/models/operations_spec.rb +2 -2
  105. data/spec/models/payment_codi_spec.rb +1 -1
  106. data/spec/models/payment_request_report_dto_spec.rb +99 -0
  107. data/spec/models/payment_request_req_spec.rb +109 -0
  108. data/spec/models/payment_request_response_spec.rb +53 -0
  109. data/spec/models/payments_spei_and_spid_order_id_spec.rb +47 -0
  110. data/spec/models/payments_spei_and_spid_request_id_spec.rb +65 -0
  111. data/spec/models/product_spec.rb +63 -0
  112. data/spec/models/recurring_charge_request_spec.rb +77 -0
  113. data/spec/models/spid_beneficiary_response_spec.rb +6 -0
  114. data/spec/models/success_charges_data_dto_spec.rb +65 -0
  115. data/spec/models/success_data_dto_spec.rb +51 -0
  116. data/spec/models/transaction_spei_spid_spec.rb +83 -0
  117. data/spec/models/transactions_register_spec.rb +59 -0
  118. data/wire4_client-1.1.3.gem +0 -0
  119. data/wire4_client.gemspec +7 -7
  120. metadata +108 -55
@@ -0,0 +1,17 @@
1
+ # Wire4Client::PaymentRequestReportDTO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **String** | | [optional]
7
+ **cancel_return_url** | **String** | | [optional]
8
+ **customer** | [**Customer**](Customer.md) | | [optional]
9
+ **description** | **String** | | [optional]
10
+ **due_date** | **String** | | [optional]
11
+ **failed_charges** | [**Array<FailedChargesDataDTO>**](FailedChargesDataDTO.md) | | [optional]
12
+ **order_id** | **String** | | [optional]
13
+ **return_url** | **String** | | [optional]
14
+ **status** | **String** | | [optional]
15
+ **success_charge** | [**SuccessDataDTO**](SuccessDataDTO.md) | | [optional]
16
+
17
+
@@ -0,0 +1,18 @@
1
+ # Wire4Client::PaymentRequestReq
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Es el monto de la solicitud de pago |
7
+ **cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usuario cancele. | [optional]
8
+ **customer** | [**Customer**](Customer.md) | Datos del cliente | [optional]
9
+ **depositant_account** | **String** | Es el número de cuenta CLABE donde se realizará el deposito. | [optional]
10
+ **description** | **String** | Es la descripción de la solicitud de pago. | [optional]
11
+ **due_date** | **Date** | Es la fecha de operación de la solicitud de pago. | [optional]
12
+ **from_date** | **Date** | Es la fecha de inicio de la solicitud de pago. | [optional]
13
+ **method** | **String** | |
14
+ **order_id** | **String** | Número de orden asignado por el cliente de Wire4 |
15
+ **return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. | [optional]
16
+ **type** | **String** | Tipo de pago por paycash | [optional]
17
+
18
+
@@ -0,0 +1,10 @@
1
+ # Wire4Client::PaymentRequestResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **reference** | **String** | Es la referencia de pago generada para la petición (solicitud). | [optional]
7
+ **request_id** | **String** | Es el identificador público generado para la petición (solicitud). | [optional]
8
+ **url** | **String** | Url del portal en donde se debe capturar los datos de la tarjeta para aplicar el cargo | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # Wire4Client::PaymentsSpeiAndSpidOrderId
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **spei** | [**Array<Payment>**](Payment.md) | Lista de las transacciones spei registradas | [optional]
7
+ **spid** | [**Array<Payment>**](Payment.md) | Lista de las transacciones spid registradas | [optional]
8
+
9
+
@@ -0,0 +1,12 @@
1
+ # Wire4Client::PaymentsSpeiAndSpidRequestId
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **authorization_date** | **DateTime** | Fecha en que el usuario propietario del token emitió la autorización | [optional]
7
+ **request_date** | **DateTime** | Fecha en que se realizó la petición de registro de transacciones | [optional]
8
+ **request_id** | **String** | Identificador de la petición del registro de transacciones | [optional]
9
+ **spei** | [**Array<Payment>**](Payment.md) | Lista de las transacciones spei registradas | [optional]
10
+ **spid** | [**Array<Payment>**](Payment.md) | Lista de las transacciones spid registradas | [optional]
11
+
12
+
data/docs/Person.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **last_name** | **String** | Apellido Materno del propietario de la cuenta |
6
+ **last_name** | **String** | Apellido Materno del propietario de la cuenta | [optional]
7
7
  **middle_name** | **String** | Apellido Paterno del propietario de la cuenta |
8
8
  **name** | **String** | Nombre(s) del propietario de la cuenta |
9
9
 
data/docs/Product.md ADDED
@@ -0,0 +1,11 @@
1
+ # Wire4Client::Product
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Monto del calgo que se aplicará de forma periodica |
7
+ **billing_period** | **String** | Periodo en el cual se aplicará el cargo, si no se especifica la propiedad frequency por defecto sera la unidad |
8
+ **frequency** | **Integer** | La frecuencia en la que se aplicará el cargo, trabaja en conjunto con la propiedad billingPeriod |
9
+ **name** | **String** | Nombre del producto sobre el cual se aplicará el cobro recurrente |
10
+
11
+
@@ -0,0 +1,14 @@
1
+ # Wire4Client::RecurringChargeRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usuario cancele. |
7
+ **charges** | **Integer** | Número de cargos que se aplicarán a la tarjeta del cliente final a partir de la fecha del primer cargo |
8
+ **customer** | [**Customer**](Customer.md) | |
9
+ **first_charge_date** | **DateTime** | Fecha en la que se aplicará el primer cargo a la tarjeta del cliente final |
10
+ **order_id** | **String** | Número de orden asignado por el cliente de Wire4 |
11
+ **product** | [**Product**](Product.md) | |
12
+ **return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
13
+
14
+
@@ -0,0 +1,107 @@
1
+ # Wire4Client::ReporteDeSolicitudesDePagosApi
2
+
3
+ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**payment_request_id_report_by_order_id_using_get**](ReporteDeSolicitudesDePagosApi.md#payment_request_id_report_by_order_id_using_get) | **GET** /payment-request | Consulta de solicitudes de pago por numero de orden.
8
+ [**payment_request_id_report_using_get**](ReporteDeSolicitudesDePagosApi.md#payment_request_id_report_using_get) | **GET** /payment-request/{requestId} | Consulta de solicitudes de pago por identificador de petición
9
+
10
+
11
+ # **payment_request_id_report_by_order_id_using_get**
12
+ > PaymentRequestReportDTO payment_request_id_report_by_order_id_using_get(authorization, opts)
13
+
14
+ Consulta de solicitudes de pago por numero de orden.
15
+
16
+ ### Example
17
+ ```ruby
18
+ # load the gem
19
+ require 'wire4_client'
20
+
21
+ api_instance = Wire4Client::ReporteDeSolicitudesDePagosApi.new
22
+
23
+ authorization = 'authorization_example' # String | Header para token
24
+
25
+ opts = {
26
+ order_id: 'order_id_example' # String | Es el identificador de la orden a buscar.
27
+ }
28
+
29
+ begin
30
+ #Consulta de solicitudes de pago por numero de orden.
31
+ result = api_instance.payment_request_id_report_by_order_id_using_get(authorization, opts)
32
+ p result
33
+ rescue Wire4Client::ApiError => e
34
+ puts "Exception when calling ReporteDeSolicitudesDePagosApi->payment_request_id_report_by_order_id_using_get: #{e}"
35
+ end
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ Name | Type | Description | Notes
41
+ ------------- | ------------- | ------------- | -------------
42
+ **authorization** | **String**| Header para token |
43
+ **order_id** | **String**| Es el identificador de la orden a buscar. | [optional]
44
+
45
+ ### Return type
46
+
47
+ [**PaymentRequestReportDTO**](PaymentRequestReportDTO.md)
48
+
49
+ ### Authorization
50
+
51
+ No authorization required
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: Not defined
56
+ - **Accept**: application/json
57
+
58
+
59
+
60
+ # **payment_request_id_report_using_get**
61
+ > PaymentRequestReportDTO payment_request_id_report_using_get(authorization, request_id)
62
+
63
+ Consulta de solicitudes de pago por identificador de petición
64
+
65
+ ### Example
66
+ ```ruby
67
+ # load the gem
68
+ require 'wire4_client'
69
+
70
+ api_instance = Wire4Client::ReporteDeSolicitudesDePagosApi.new
71
+
72
+ authorization = 'authorization_example' # String | Header para token
73
+
74
+ request_id = 'request_id_example' # String | Identificador de la petición a buscar.
75
+
76
+
77
+ begin
78
+ #Consulta de solicitudes de pago por identificador de petición
79
+ result = api_instance.payment_request_id_report_using_get(authorization, request_id)
80
+ p result
81
+ rescue Wire4Client::ApiError => e
82
+ puts "Exception when calling ReporteDeSolicitudesDePagosApi->payment_request_id_report_using_get: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ Name | Type | Description | Notes
89
+ ------------- | ------------- | ------------- | -------------
90
+ **authorization** | **String**| Header para token |
91
+ **request_id** | **String**| Identificador de la petición a buscar. |
92
+
93
+ ### Return type
94
+
95
+ [**PaymentRequestReportDTO**](PaymentRequestReportDTO.md)
96
+
97
+ ### Authorization
98
+
99
+ No authorization required
100
+
101
+ ### HTTP request headers
102
+
103
+ - **Content-Type**: Not defined
104
+ - **Accept**: application/json
105
+
106
+
107
+
@@ -0,0 +1,59 @@
1
+ # Wire4Client::SolicitudDePagosApi
2
+
3
+ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**register_payment_request_using_post**](SolicitudDePagosApi.md#register_payment_request_using_post) | **POST** /payment-request | Registro de solicitud de pagos
8
+
9
+
10
+ # **register_payment_request_using_post**
11
+ > PaymentRequestResponse register_payment_request_using_post(authorization, payment_request_req_dto)
12
+
13
+ Registro de solicitud de pagos
14
+
15
+ Se registra una solicitud de pagos. En la respuesta se proporcionará una dirección URL que lo llevará al sitio donde se le solicitará ingresar los datos de tarjeta a la que se aplicarán los cargos.
16
+
17
+ ### Example
18
+ ```ruby
19
+ # load the gem
20
+ require 'wire4_client'
21
+
22
+ api_instance = Wire4Client::SolicitudDePagosApi.new
23
+
24
+ authorization = 'authorization_example' # String | Header para token
25
+
26
+ payment_request_req_dto = Wire4Client::PaymentRequestReq.new # PaymentRequestReq | Información de la solicitud de pagos
27
+
28
+
29
+ begin
30
+ #Registro de solicitud de pagos
31
+ result = api_instance.register_payment_request_using_post(authorization, payment_request_req_dto)
32
+ p result
33
+ rescue Wire4Client::ApiError => e
34
+ puts "Exception when calling SolicitudDePagosApi->register_payment_request_using_post: #{e}"
35
+ end
36
+ ```
37
+
38
+ ### Parameters
39
+
40
+ Name | Type | Description | Notes
41
+ ------------- | ------------- | ------------- | -------------
42
+ **authorization** | **String**| Header para token |
43
+ **payment_request_req_dto** | [**PaymentRequestReq**](PaymentRequestReq.md)| Información de la solicitud de pagos |
44
+
45
+ ### Return type
46
+
47
+ [**PaymentRequestResponse**](PaymentRequestResponse.md)
48
+
49
+ ### Authorization
50
+
51
+ No authorization required
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: application/json
56
+ - **Accept**: application/json
57
+
58
+
59
+
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **amount_limit** | **Float** | Monto límite permitido para la cuenta. Ejemplo: 1000.00 |
7
+ **authorization_date** | **DateTime** | La fecha en la que se registro el beneficiario. | [optional]
7
8
  **bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta. | [optional]
8
9
  **beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE. Ejemplo: 032180000118359719. |
9
10
  **email** | **Array<String>** | Lista de correos electrónicos (emails), este dato es opcional. | [optional]
@@ -0,0 +1,12 @@
1
+ # Wire4Client::SuccessChargesDataDTO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **authorization** | **String** | | [optional]
7
+ **brand** | **String** | | [optional]
8
+ **card_number** | **String** | | [optional]
9
+ **date** | **String** | | [optional]
10
+ **holder_name** | **String** | | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # Wire4Client::SuccessDataDTO
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **data** | [**SuccessChargesDataDTO**](SuccessChargesDataDTO.md) | | [optional]
7
+ **method** | **String** | | [optional]
8
+
9
+
@@ -0,0 +1,15 @@
1
+ # Wire4Client::TransactionSpeiSpid
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Es el monto de la transferencia. Se valida que sean máximo 20 dígitos y 2 decimales. Ejemplo 1000.00 |
7
+ **beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un número celular (10dígitos), tarjeta de débito (TDD) o Cuenta CLABE interbancaria (18 dígitos). |
8
+ **classification_id** | **String** | Es el identificador de la clasificación de la transferencia SPID. |
9
+ **concept** | **String** | Es el concepto de la transferencia. |
10
+ **currency_code** | **String** | Código de moneda en la que opera la cuenta. | [optional]
11
+ **email** | **Array<String>** | Lista de correo electrónico (email) del beneficiario. Este campo es opcional. | [optional]
12
+ **order_id** | **String** | Es la referencia de la transferencia asignada por el cliente. Ejemplo: dae9c6ae-8c7a-42e8-99f4-ebe90566efae |
13
+ **reference** | **Integer** | Es la referencia numérica de la transferencia. |
14
+
15
+
@@ -0,0 +1,11 @@
1
+ # Wire4Client::TransactionsRegister
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usario cancele el registro. |
7
+ **return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
8
+ **spei** | [**Array<TransactionSpeiSpid>**](TransactionSpeiSpid.md) | Lista de transacciones SPEI | [optional]
9
+ **spid** | [**Array<TransactionSpeiSpid>**](TransactionSpeiSpid.md) | Lista de transacciones SPID | [optional]
10
+
11
+
@@ -8,8 +8,11 @@ Method | HTTP request | Description
8
8
  [**drop_transactions_pending_using_delete**](TransferenciasSPEIApi.md#drop_transactions_pending_using_delete) | **DELETE** /subscriptions/{subscription}/transactions/outcoming/spei/request/{requestId} | Eliminación de transferencias SPEI® pendientes
9
9
  [**incoming_spei_transactions_report_using_get**](TransferenciasSPEIApi.md#incoming_spei_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/incoming/spei | Consulta de transferencias recibidas
10
10
  [**out_comming_spei_request_id_transactions_report_using_get**](TransferenciasSPEIApi.md#out_comming_spei_request_id_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming/spei/{requestId} | Consulta de transferencias de salida por identificador de petición
11
+ [**out_comming_spei_spid_order_id_transaction_report_using_get**](TransferenciasSPEIApi.md#out_comming_spei_spid_order_id_transaction_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming | Consulta de transferencias realizadas por order_id
12
+ [**out_comming_spei_spid_request_id_transactions_report_using_get**](TransferenciasSPEIApi.md#out_comming_spei_spid_request_id_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming/{requestId} | Consulta de transferencias de salida por identificador de petición
11
13
  [**outgoing_spei_transactions_report_using_get**](TransferenciasSPEIApi.md#outgoing_spei_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming/spei | Consulta de transferencias realizadas
12
14
  [**register_outgoing_spei_transaction_using_post**](TransferenciasSPEIApi.md#register_outgoing_spei_transaction_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming/spei | Registro de transferencias
15
+ [**register_spei_spid_outgoing_transactions_using_post**](TransferenciasSPEIApi.md#register_spei_spid_outgoing_transactions_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming | Registro de transferencias SPEI y SPID
13
16
 
14
17
 
15
18
  # **create_authorization_transactions_group**
@@ -230,6 +233,113 @@ No authorization required
230
233
 
231
234
 
232
235
 
236
+ # **out_comming_spei_spid_order_id_transaction_report_using_get**
237
+ > PaymentsSpeiAndSpidOrderId out_comming_spei_spid_order_id_transaction_report_using_get(authorization, subscription, opts)
238
+
239
+ Consulta de transferencias realizadas por order_id
240
+
241
+ Consulta las transferencias que regresa este recuso son únicamente las transferencias recibidas en el día en el que se realiza la consulta o las transferencias identificadas con el <strong>order_id</strong> proporcionado, para este tipo de consultas no importa el día en el que se realizó la transferencia. <br> Es importante que conozca que la respuesta puede dar como resultado un objeto con una lista spei o una lista spid con el/los elementos ya que un identificador order_id solo puede pertenecer a una transacción sea spei o spid.
242
+
243
+ ### Example
244
+ ```ruby
245
+ # load the gem
246
+ require 'wire4_client'
247
+
248
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
249
+
250
+ authorization = 'authorization_example' # String | Header para token
251
+
252
+ subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
253
+
254
+ opts = {
255
+ order_id: 'order_id_example' # String | Es el identificador de la orden a buscar.
256
+ }
257
+
258
+ begin
259
+ #Consulta de transferencias realizadas por order_id
260
+ result = api_instance.out_comming_spei_spid_order_id_transaction_report_using_get(authorization, subscription, opts)
261
+ p result
262
+ rescue Wire4Client::ApiError => e
263
+ puts "Exception when calling TransferenciasSPEIApi->out_comming_spei_spid_order_id_transaction_report_using_get: #{e}"
264
+ end
265
+ ```
266
+
267
+ ### Parameters
268
+
269
+ Name | Type | Description | Notes
270
+ ------------- | ------------- | ------------- | -------------
271
+ **authorization** | **String**| Header para token |
272
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. |
273
+ **order_id** | **String**| Es el identificador de la orden a buscar. | [optional]
274
+
275
+ ### Return type
276
+
277
+ [**PaymentsSpeiAndSpidOrderId**](PaymentsSpeiAndSpidOrderId.md)
278
+
279
+ ### Authorization
280
+
281
+ No authorization required
282
+
283
+ ### HTTP request headers
284
+
285
+ - **Content-Type**: Not defined
286
+ - **Accept**: application/json
287
+
288
+
289
+
290
+ # **out_comming_spei_spid_request_id_transactions_report_using_get**
291
+ > PaymentsSpeiAndSpidRequestId out_comming_spei_spid_request_id_transactions_report_using_get(authorization, request_id, subscription)
292
+
293
+ Consulta de transferencias de salida por identificador de petición
294
+
295
+ Consulta las transferencias de salida registradas en una petición, las transferencias que regresa este recuso son únicamente las transferencias de salida agrupadas al identificador de la petición que se generó al hacer el registro de las transacciones el cuál se debe especificar como parte del path de este endpoint.
296
+
297
+ ### Example
298
+ ```ruby
299
+ # load the gem
300
+ require 'wire4_client'
301
+
302
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
303
+
304
+ authorization = 'authorization_example' # String | Header para token
305
+
306
+ request_id = 'request_id_example' # String | Identificador de la petición a buscar.
307
+
308
+ subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
309
+
310
+
311
+ begin
312
+ #Consulta de transferencias de salida por identificador de petición
313
+ result = api_instance.out_comming_spei_spid_request_id_transactions_report_using_get(authorization, request_id, subscription)
314
+ p result
315
+ rescue Wire4Client::ApiError => e
316
+ puts "Exception when calling TransferenciasSPEIApi->out_comming_spei_spid_request_id_transactions_report_using_get: #{e}"
317
+ end
318
+ ```
319
+
320
+ ### Parameters
321
+
322
+ Name | Type | Description | Notes
323
+ ------------- | ------------- | ------------- | -------------
324
+ **authorization** | **String**| Header para token |
325
+ **request_id** | **String**| Identificador de la petición a buscar. |
326
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. |
327
+
328
+ ### Return type
329
+
330
+ [**PaymentsSpeiAndSpidRequestId**](PaymentsSpeiAndSpidRequestId.md)
331
+
332
+ ### Authorization
333
+
334
+ No authorization required
335
+
336
+ ### HTTP request headers
337
+
338
+ - **Content-Type**: Not defined
339
+ - **Accept**: application/json
340
+
341
+
342
+
233
343
  # **outgoing_spei_transactions_report_using_get**
234
344
  > Array&lt;Payment&gt; outgoing_spei_transactions_report_using_get(authorization, subscription, opts)
235
345
 
@@ -337,3 +447,56 @@ No authorization required
337
447
 
338
448
 
339
449
 
450
+ # **register_spei_spid_outgoing_transactions_using_post**
451
+ > TokenRequiredResponse register_spei_spid_outgoing_transactions_using_post(authorization, subscription, transactions)
452
+
453
+ Registro de transferencias SPEI y SPID
454
+
455
+ Se registra un conjunto de transferencias (una o más) tanto SPEI como SPID en una sola petición en la cuenta del cliente Monex relacionada a la suscripción. En la respuesta se proporcionará una dirección URL que lo llevará al centro de autorización para que las transferencias sean confirmadas (autorizadas) por el cliente para que se efectúen, para ello debe ingresar la llave electrónica (Token).<br> Nota: Debe considerar que el concepto de cada una de las transacciones solo debe contener caracteres alfanuméricos por lo que en caso de que se reciban caracteres como ñ o acentos serán sustituidos por n o en su caso por la letra sin acento. Los caracteres no alfanuméricos como pueden ser caracteres especiales serán eliminados.
456
+
457
+ ### Example
458
+ ```ruby
459
+ # load the gem
460
+ require 'wire4_client'
461
+
462
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
463
+
464
+ authorization = 'authorization_example' # String | Header para token
465
+
466
+ subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
467
+
468
+ transactions = Wire4Client::TransactionsRegister.new # TransactionsRegister | Información de las transferencias SPEI y SPID de salida
469
+
470
+
471
+ begin
472
+ #Registro de transferencias SPEI y SPID
473
+ result = api_instance.register_spei_spid_outgoing_transactions_using_post(authorization, subscription, transactions)
474
+ p result
475
+ rescue Wire4Client::ApiError => e
476
+ puts "Exception when calling TransferenciasSPEIApi->register_spei_spid_outgoing_transactions_using_post: #{e}"
477
+ end
478
+ ```
479
+
480
+ ### Parameters
481
+
482
+ Name | Type | Description | Notes
483
+ ------------- | ------------- | ------------- | -------------
484
+ **authorization** | **String**| Header para token |
485
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. |
486
+ **transactions** | [**TransactionsRegister**](TransactionsRegister.md)| Información de las transferencias SPEI y SPID de salida |
487
+
488
+ ### Return type
489
+
490
+ [**TokenRequiredResponse**](TokenRequiredResponse.md)
491
+
492
+ ### Authorization
493
+
494
+ No authorization required
495
+
496
+ ### HTTP request headers
497
+
498
+ - **Content-Type**: application/json
499
+ - **Accept**: application/json
500
+
501
+
502
+
@@ -0,0 +1,143 @@
1
+ =begin
2
+ #Wire4RestAPI
3
+
4
+ #Referencia de la API de Wire4
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.10
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module Wire4Client
16
+ class CargosRecurrentesApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Cancelación/desubscripción de cargos recurrentes
23
+ # Se solicita la desuscripción de un cargo recurrente activo. En el request llevará el orderId que identifica el cargo recurrente a eliminar/dar de baja se deshabilitará tanto de openpay como del sistem wire4.<br> Nota: Debe considerar que para hacer uso de esta funcionalidad debe contar con un scope especial
24
+ # @param authorization Header para token
25
+ # @param order_id orderId
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [ConfirmRecurringCharge]
28
+ def delete_recurring_charge_using_delete(authorization, order_id, opts = {})
29
+ data, _status_code, _headers = delete_recurring_charge_using_delete_with_http_info(authorization, order_id, opts)
30
+ data
31
+ end
32
+
33
+ # Cancelación/desubscripción de cargos recurrentes
34
+ # Se solicita la desuscripción de un cargo recurrente activo. En el request llevará el orderId que identifica el cargo recurrente a eliminar/dar de baja se deshabilitará tanto de openpay como del sistem wire4.&lt;br&gt; Nota: Debe considerar que para hacer uso de esta funcionalidad debe contar con un scope especial
35
+ # @param authorization Header para token
36
+ # @param order_id orderId
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(ConfirmRecurringCharge, Fixnum, Hash)>] ConfirmRecurringCharge data, response status code and response headers
39
+ def delete_recurring_charge_using_delete_with_http_info(authorization, order_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: CargosRecurrentesApi.delete_recurring_charge_using_delete ...'
42
+ end
43
+ # verify the required parameter 'authorization' is set
44
+ if @api_client.config.client_side_validation && authorization.nil?
45
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling CargosRecurrentesApi.delete_recurring_charge_using_delete"
46
+ end
47
+ # verify the required parameter 'order_id' is set
48
+ if @api_client.config.client_side_validation && order_id.nil?
49
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling CargosRecurrentesApi.delete_recurring_charge_using_delete"
50
+ end
51
+ # resource path
52
+ local_var_path = '/recurring-charge/{orderId}'.sub('{' + 'orderId' + '}', order_id.to_s)
53
+
54
+ # query parameters
55
+ query_params = {}
56
+
57
+ # header parameters
58
+ header_params = {}
59
+ # HTTP header 'Accept' (if needed)
60
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
61
+ header_params[:'Authorization'] = authorization
62
+
63
+ # form parameters
64
+ form_params = {}
65
+
66
+ # http body (model)
67
+ post_body = nil
68
+ auth_names = []
69
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => 'ConfirmRecurringCharge')
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: CargosRecurrentesApi#delete_recurring_charge_using_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+ # Registro de cargos recurrentes
82
+ # Se registra una solicitud para generar un plan de cargos recurrentes. En la respuesta se proporcionará una dirección URL que lo llevará al sitio donde se le solicitará ingresar los datos de tarjeta a la que se aplicarán los cargos de acuerdo al plan seleccionado.<br> Nota: Debe considerar que para hacer uso de esta funcionalidad debe contar con un scope especial
83
+ # @param authorization Header para token
84
+ # @param request_recurring_charge Información de la solicitud para aplicar cargos recurrentes
85
+ # @param [Hash] opts the optional parameters
86
+ # @return [ConfirmRecurringCharge]
87
+ def register_recurring_charge_using_post(authorization, request_recurring_charge, opts = {})
88
+ data, _status_code, _headers = register_recurring_charge_using_post_with_http_info(authorization, request_recurring_charge, opts)
89
+ data
90
+ end
91
+
92
+ # Registro de cargos recurrentes
93
+ # Se registra una solicitud para generar un plan de cargos recurrentes. En la respuesta se proporcionará una dirección URL que lo llevará al sitio donde se le solicitará ingresar los datos de tarjeta a la que se aplicarán los cargos de acuerdo al plan seleccionado.&lt;br&gt; Nota: Debe considerar que para hacer uso de esta funcionalidad debe contar con un scope especial
94
+ # @param authorization Header para token
95
+ # @param request_recurring_charge Información de la solicitud para aplicar cargos recurrentes
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [Array<(ConfirmRecurringCharge, Fixnum, Hash)>] ConfirmRecurringCharge data, response status code and response headers
98
+ def register_recurring_charge_using_post_with_http_info(authorization, request_recurring_charge, opts = {})
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug 'Calling API: CargosRecurrentesApi.register_recurring_charge_using_post ...'
101
+ end
102
+ # verify the required parameter 'authorization' is set
103
+ if @api_client.config.client_side_validation && authorization.nil?
104
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling CargosRecurrentesApi.register_recurring_charge_using_post"
105
+ end
106
+ # verify the required parameter 'request_recurring_charge' is set
107
+ if @api_client.config.client_side_validation && request_recurring_charge.nil?
108
+ fail ArgumentError, "Missing the required parameter 'request_recurring_charge' when calling CargosRecurrentesApi.register_recurring_charge_using_post"
109
+ end
110
+ # resource path
111
+ local_var_path = '/recurring-charge'
112
+
113
+ # query parameters
114
+ query_params = {}
115
+
116
+ # header parameters
117
+ header_params = {}
118
+ # HTTP header 'Accept' (if needed)
119
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
120
+ # HTTP header 'Content-Type'
121
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
122
+ header_params[:'Authorization'] = authorization
123
+
124
+ # form parameters
125
+ form_params = {}
126
+
127
+ # http body (model)
128
+ post_body = @api_client.object_to_http_body(request_recurring_charge)
129
+ auth_names = []
130
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
131
+ :header_params => header_params,
132
+ :query_params => query_params,
133
+ :form_params => form_params,
134
+ :body => post_body,
135
+ :auth_names => auth_names,
136
+ :return_type => 'ConfirmRecurringCharge')
137
+ if @api_client.config.debugging
138
+ @api_client.config.logger.debug "API called: CargosRecurrentesApi#register_recurring_charge_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
139
+ end
140
+ return data, status_code, headers
141
+ end
142
+ end
143
+ end