wire4_client 1.0.3 → 1.0.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +50 -7
- data/docs/Account.md +3 -3
- data/docs/AccountDetail.md +13 -0
- data/docs/AccountReassigned.md +21 -0
- data/docs/AccountResponse.md +4 -3
- data/docs/AddressCompany.md +17 -0
- data/docs/AmountRequest.md +2 -0
- data/docs/AuthorizationTransactionGroup.md +9 -0
- data/docs/AuthorizedBeneficiariesResponse.md +10 -0
- data/docs/AuthorizedUsers.md +13 -0
- data/docs/CertificateRequest.md +11 -0
- data/docs/CodiCodeQrResponseDTO.md +17 -0
- data/docs/CodiCodeRequestDTO.md +14 -0
- data/docs/CodiOperationResponseDTO.md +14 -0
- data/docs/CodiOperationsFiltersRequestDTO.md +15 -0
- data/docs/CompanyRegistered.md +13 -0
- data/docs/CompanyRequested.md +11 -0
- data/docs/Compay.md +11 -0
- data/docs/ContractDetailRequest.md +11 -0
- data/docs/ContractDetailResponse.md +9 -0
- data/docs/ContractsDetailsApi.md +167 -0
- data/docs/CuentasDeBeneficiariosSPEIApi.md +69 -4
- data/docs/CuentasDeBeneficiariosSPIDApi.md +11 -1
- data/docs/EmpresasCoDiApi.md +107 -0
- data/docs/MessageAccountBeneficiary.md +2 -2
- data/docs/MessageCEP.md +9 -9
- data/docs/MessageCodiAction.md +19 -0
- data/docs/MessagePayment.md +3 -1
- data/docs/MessagePaymentStatePending.md +23 -0
- data/docs/MessageRequestChanged.md +2 -2
- data/docs/MessageSalesPoint.md +10 -0
- data/docs/MessageSubscription.md +6 -6
- data/docs/MessageUserAuthorized.md +13 -0
- data/docs/MessageWebHook.md +2 -2
- data/docs/OperacionesCoDiApi.md +68 -0
- data/docs/Operations.md +17 -0
- data/docs/PagerResponseDto.md +13 -0
- data/docs/Payment.md +3 -1
- data/docs/PaymentRequestCodiResponseDTO.md +18 -0
- data/docs/PeticionesDePagoPorCoDiApi.md +116 -0
- data/docs/PreMonexAuthorization.md +11 -0
- data/docs/PuntosDeVentaCoDiApi.md +113 -0
- data/docs/SalesPoint.md +10 -0
- data/docs/SalesPointFound.md +14 -0
- data/docs/SalesPointRequest.md +11 -0
- data/docs/SalesPointRespose.md +11 -0
- data/docs/SpidBeneficiaryResponse.md +2 -0
- data/docs/SuscripcionesApi.md +14 -14
- data/docs/TransactionOutgoing.md +2 -1
- data/docs/TransferenciasSPEIApi.md +60 -2
- data/docs/UrlsRedirect.md +9 -0
- data/docs/UserCompany.md +16 -0
- data/docs/Webhook.md +13 -0
- data/lib/wire4_client.rb +36 -0
- data/lib/wire4_client/api/contracts_details_api.rb +230 -0
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +100 -5
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +15 -0
- data/lib/wire4_client/api/empresas_co_di_api.rb +137 -0
- data/lib/wire4_client/api/operaciones_co_di_api.rb +92 -0
- data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +178 -0
- data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +151 -0
- data/lib/wire4_client/api/suscripciones_api.rb +14 -14
- data/lib/wire4_client/api/transferencias_spei_api.rb +82 -0
- data/lib/wire4_client/models/account.rb +3 -3
- data/lib/wire4_client/models/account_detail.rb +239 -0
- data/lib/wire4_client/models/account_reassigned.rb +375 -0
- data/lib/wire4_client/models/account_response.rb +14 -4
- data/lib/wire4_client/models/address_company.rb +275 -0
- data/lib/wire4_client/models/amount_request.rb +90 -4
- data/lib/wire4_client/models/authorization_transaction_group.rb +207 -0
- data/lib/wire4_client/models/authorized_beneficiaries_response.rb +206 -0
- data/lib/wire4_client/models/authorized_users.rb +235 -0
- data/lib/wire4_client/models/certificate_request.rb +248 -0
- data/lib/wire4_client/models/codi_code_qr_response_dto.rb +320 -0
- data/lib/wire4_client/models/codi_code_request_dto.rb +402 -0
- data/lib/wire4_client/models/codi_operation_response_dto.rb +245 -0
- data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +336 -0
- data/lib/wire4_client/models/company_registered.rb +235 -0
- data/lib/wire4_client/models/company_requested.rb +215 -0
- data/lib/wire4_client/models/compay.rb +215 -0
- data/lib/wire4_client/models/contract_detail_request.rb +247 -0
- data/lib/wire4_client/models/contract_detail_response.rb +194 -0
- data/lib/wire4_client/models/message_account_beneficiary.rb +2 -2
- data/lib/wire4_client/models/message_cep.rb +10 -10
- data/lib/wire4_client/models/message_codi_action.rb +295 -0
- data/lib/wire4_client/models/message_deposit_received.rb +1 -1
- data/lib/wire4_client/models/message_payment.rb +23 -2
- data/lib/wire4_client/models/message_payment_state_pending.rb +335 -0
- data/lib/wire4_client/models/message_request_changed.rb +3 -3
- data/lib/wire4_client/models/message_sales_point.rb +205 -0
- data/lib/wire4_client/models/message_subscription.rb +7 -7
- data/lib/wire4_client/models/message_user_authorized.rb +235 -0
- data/lib/wire4_client/models/message_web_hook.rb +2 -2
- data/lib/wire4_client/models/operations.rb +321 -0
- data/lib/wire4_client/models/pager_response_dto.rb +236 -0
- data/lib/wire4_client/models/payment.rb +22 -2
- data/lib/wire4_client/models/payment_request_codi_response_dto.rb +287 -0
- data/lib/wire4_client/models/pre_monex_authorization.rb +291 -0
- data/lib/wire4_client/models/sales_point.rb +205 -0
- data/lib/wire4_client/models/sales_point_found.rb +279 -0
- data/lib/wire4_client/models/sales_point_request.rb +254 -0
- data/lib/wire4_client/models/sales_point_respose.rb +215 -0
- data/lib/wire4_client/models/spid_beneficiary_response.rb +24 -4
- data/lib/wire4_client/models/transaction_outgoing.rb +12 -2
- data/lib/wire4_client/models/urls_redirect.rb +205 -0
- data/lib/wire4_client/models/user_company.rb +269 -0
- data/lib/wire4_client/models/webhook.rb +271 -0
- data/lib/wire4_client/version.rb +1 -1
- data/spec/api/contracts_details_api_spec.rb +76 -0
- data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +20 -1
- data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +5 -0
- data/spec/api/empresas_co_di_api_spec.rb +60 -0
- data/spec/api/operaciones_co_di_api_spec.rb +52 -0
- data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +63 -0
- data/spec/api/puntos_de_venta_co_di_api_spec.rb +62 -0
- data/spec/api/suscripciones_api_spec.rb +7 -7
- data/spec/api/transferencias_spei_api_spec.rb +15 -0
- data/spec/models/account_detail_spec.rb +71 -0
- data/spec/models/account_reassigned_spec.rb +119 -0
- data/spec/models/account_response_spec.rb +6 -0
- data/spec/models/address_company_spec.rb +95 -0
- data/spec/models/amount_request_spec.rb +12 -0
- data/spec/models/authorization_transaction_group_spec.rb +47 -0
- data/spec/models/authorized_beneficiaries_response_spec.rb +53 -0
- data/spec/models/authorized_users_spec.rb +71 -0
- data/spec/models/certificate_request_spec.rb +59 -0
- data/spec/models/codi_code_qr_response_dto_spec.rb +103 -0
- data/spec/models/codi_code_request_dto_spec.rb +81 -0
- data/spec/models/codi_operation_response_dto_spec.rb +77 -0
- data/spec/models/codi_operations_filters_request_dto_spec.rb +87 -0
- data/spec/models/company_registered_spec.rb +71 -0
- data/spec/models/company_requested_spec.rb +59 -0
- data/spec/models/compay_spec.rb +59 -0
- data/spec/models/contract_detail_request_spec.rb +59 -0
- data/spec/models/contract_detail_response_spec.rb +47 -0
- data/spec/models/message_codi_action_spec.rb +107 -0
- data/spec/models/message_payment_spec.rb +12 -0
- data/spec/models/message_payment_state_pending_spec.rb +131 -0
- data/spec/models/message_sales_point_spec.rb +53 -0
- data/spec/models/message_user_authorized_spec.rb +71 -0
- data/spec/models/operations_spec.rb +103 -0
- data/spec/models/pager_response_dto_spec.rb +71 -0
- data/spec/models/payment_request_codi_response_dto_spec.rb +101 -0
- data/spec/models/payment_spec.rb +12 -0
- data/spec/models/pre_monex_authorization_spec.rb +59 -0
- data/spec/models/sales_point_found_spec.rb +81 -0
- data/spec/models/sales_point_request_spec.rb +59 -0
- data/spec/models/sales_point_respose_spec.rb +59 -0
- data/spec/models/sales_point_spec.rb +53 -0
- data/spec/models/spid_beneficiary_response_spec.rb +12 -0
- data/spec/models/transaction_outgoing_spec.rb +6 -0
- data/spec/models/urls_redirect_spec.rb +47 -0
- data/spec/models/user_company_spec.rb +89 -0
- data/spec/models/webhook_spec.rb +75 -0
- metadata +146 -3
- data/Gemfile.lock +0 -69
@@ -4,6 +4,7 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**authorize_accounts_pending_put**](CuentasDeBeneficiariosSPEIApi.md#authorize_accounts_pending_put) | **PUT** /subscriptions/{subscription}/beneficiaries/pending | Recibe la solicitud para agrupar las cuentas SPEI/SPID de beneficiarios en estado pendiente que deben ser autorizadas
|
7
8
|
[**delete_account_using_delete**](CuentasDeBeneficiariosSPEIApi.md#delete_account_using_delete) | **DELETE** /subscriptions/{subscription}/beneficiaries/spei/{account} | Elimina la cuenta del beneficiario
|
8
9
|
[**get_available_relationships_monex_using_get**](CuentasDeBeneficiariosSPEIApi.md#get_available_relationships_monex_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/relationships | Consulta de relaciones
|
9
10
|
[**get_beneficiaries_by_request_id**](CuentasDeBeneficiariosSPEIApi.md#get_beneficiaries_by_request_id) | **GET** /subscriptions/{subscription}/beneficiaries/spei/{requestId} | Consulta los beneficiarios por el identificador de la petición de registro
|
@@ -13,6 +14,59 @@ Method | HTTP request | Description
|
|
13
14
|
[**update_amount_limit_account_using_put**](CuentasDeBeneficiariosSPEIApi.md#update_amount_limit_account_using_put) | **PUT** /subscriptions/{subscription}/beneficiaries/spei/{account} | Actualiza el monto límite
|
14
15
|
|
15
16
|
|
17
|
+
# **authorize_accounts_pending_put**
|
18
|
+
> AuthorizedBeneficiariesResponse authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto)
|
19
|
+
|
20
|
+
Recibe la solicitud para agrupar las cuentas SPEI/SPID de beneficiarios en estado pendiente que deben ser autorizadas
|
21
|
+
|
22
|
+
Solicta autorizar las cuentas de beneficiarios en estado pendiente agrupandolas en un set de cuentas que pueden incluir tanto cuentas de SPI como de SPID, debe indicar las urls de redireccion en caso de error y en caso de exito<br/>
|
23
|
+
|
24
|
+
### Example
|
25
|
+
```ruby
|
26
|
+
# load the gem
|
27
|
+
require 'wire4_client'
|
28
|
+
|
29
|
+
api_instance = Wire4Client::CuentasDeBeneficiariosSPEIApi.new
|
30
|
+
|
31
|
+
authorization = 'authorization_example' # String | Header para token
|
32
|
+
|
33
|
+
subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
|
34
|
+
|
35
|
+
urls_redirect_dto = Wire4Client::UrlsRedirect.new # UrlsRedirect | Información de la cuenta del beneficiario
|
36
|
+
|
37
|
+
|
38
|
+
begin
|
39
|
+
#Recibe la solicitud para agrupar las cuentas SPEI/SPID de beneficiarios en estado pendiente que deben ser autorizadas
|
40
|
+
result = api_instance.authorize_accounts_pending_put(authorization, subscription, urls_redirect_dto)
|
41
|
+
p result
|
42
|
+
rescue Wire4Client::ApiError => e
|
43
|
+
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->authorize_accounts_pending_put: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
### Parameters
|
48
|
+
|
49
|
+
Name | Type | Description | Notes
|
50
|
+
------------- | ------------- | ------------- | -------------
|
51
|
+
**authorization** | **String**| Header para token |
|
52
|
+
**subscription** | **String**| El identificador de la suscripción a esta API |
|
53
|
+
**urls_redirect_dto** | [**UrlsRedirect**](UrlsRedirect.md)| Información de la cuenta del beneficiario |
|
54
|
+
|
55
|
+
### Return type
|
56
|
+
|
57
|
+
[**AuthorizedBeneficiariesResponse**](AuthorizedBeneficiariesResponse.md)
|
58
|
+
|
59
|
+
### Authorization
|
60
|
+
|
61
|
+
No authorization required
|
62
|
+
|
63
|
+
### HTTP request headers
|
64
|
+
|
65
|
+
- **Content-Type**: application/json
|
66
|
+
- **Accept**: application/json
|
67
|
+
|
68
|
+
|
69
|
+
|
16
70
|
# **delete_account_using_delete**
|
17
71
|
> delete_account_using_delete(authorization, account, subscription)
|
18
72
|
|
@@ -188,7 +242,12 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
|
|
188
242
|
|
189
243
|
opts = {
|
190
244
|
account: 'account_example', # String | Cuenta del beneficiario, puede ser Clabe, TDD o Celular
|
191
|
-
|
245
|
+
beneficiary_bank: 'beneficiary_bank_example', # String | Clave del banco beneficiario
|
246
|
+
beneficiary_name: 'beneficiary_name_example', # String | Nombre del beneficiario
|
247
|
+
end_date: 'end_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
|
248
|
+
init_date: 'init_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
|
249
|
+
rfc: 'rfc_example', # String | RFC del beneficiario
|
250
|
+
status: 'status_example' # String | Estatus de la cuenta
|
192
251
|
}
|
193
252
|
|
194
253
|
begin
|
@@ -207,7 +266,12 @@ Name | Type | Description | Notes
|
|
207
266
|
**authorization** | **String**| Header para token |
|
208
267
|
**subscription** | **String**| El identificador de la suscripción a esta API |
|
209
268
|
**account** | **String**| Cuenta del beneficiario, puede ser Clabe, TDD o Celular | [optional]
|
269
|
+
**beneficiary_bank** | **String**| Clave del banco beneficiario | [optional]
|
270
|
+
**beneficiary_name** | **String**| Nombre del beneficiario | [optional]
|
271
|
+
**end_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional]
|
272
|
+
**init_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional]
|
210
273
|
**rfc** | **String**| RFC del beneficiario | [optional]
|
274
|
+
**status** | **String**| Estatus de la cuenta | [optional]
|
211
275
|
|
212
276
|
### Return type
|
213
277
|
|
@@ -330,7 +394,7 @@ No authorization required
|
|
330
394
|
|
331
395
|
|
332
396
|
# **update_amount_limit_account_using_put**
|
333
|
-
> update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
397
|
+
> TokenRequiredResponse update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
334
398
|
|
335
399
|
Actualiza el monto límite
|
336
400
|
|
@@ -354,7 +418,8 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
|
|
354
418
|
|
355
419
|
begin
|
356
420
|
#Actualiza el monto límite
|
357
|
-
api_instance.update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
421
|
+
result = api_instance.update_amount_limit_account_using_put(authorization, account, request_dto, subscription)
|
422
|
+
p result
|
358
423
|
rescue Wire4Client::ApiError => e
|
359
424
|
puts "Exception when calling CuentasDeBeneficiariosSPEIApi->update_amount_limit_account_using_put: #{e}"
|
360
425
|
end
|
@@ -371,7 +436,7 @@ Name | Type | Description | Notes
|
|
371
436
|
|
372
437
|
### Return type
|
373
438
|
|
374
|
-
|
439
|
+
[**TokenRequiredResponse**](TokenRequiredResponse.md)
|
375
440
|
|
376
441
|
### Authorization
|
377
442
|
|
@@ -28,7 +28,12 @@ subscription = 'subscription_example' # String | El identificador de la suscripc
|
|
28
28
|
|
29
29
|
opts = {
|
30
30
|
account: 'account_example', # String | Cuenta del beneficiario, puede ser Clabe, TDD o Celular
|
31
|
-
|
31
|
+
beneficiary_bank: 'beneficiary_bank_example', # String | Clave del banco beneficiario
|
32
|
+
beneficiary_name: 'beneficiary_name_example', # String | Nombre del beneficiario
|
33
|
+
end_date: 'end_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
|
34
|
+
init_date: 'init_date_example', # String | Fecha de inicio del perido a filtrar en formato dd-mm-yyyy
|
35
|
+
rfc: 'rfc_example', # String | RFC del beneficiario
|
36
|
+
status: 'status_example' # String | Estatus de la cuenta
|
32
37
|
}
|
33
38
|
|
34
39
|
begin
|
@@ -47,7 +52,12 @@ Name | Type | Description | Notes
|
|
47
52
|
**authorization** | **String**| Header para token |
|
48
53
|
**subscription** | **String**| El identificador de la suscripción a esta API |
|
49
54
|
**account** | **String**| Cuenta del beneficiario, puede ser Clabe, TDD o Celular | [optional]
|
55
|
+
**beneficiary_bank** | **String**| Clave del banco beneficiario | [optional]
|
56
|
+
**beneficiary_name** | **String**| Nombre del beneficiario | [optional]
|
57
|
+
**end_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional]
|
58
|
+
**init_date** | **String**| Fecha de inicio del perido a filtrar en formato dd-mm-yyyy | [optional]
|
50
59
|
**rfc** | **String**| RFC del beneficiario | [optional]
|
60
|
+
**status** | **String**| Estatus de la cuenta | [optional]
|
51
61
|
|
52
62
|
### Return type
|
53
63
|
|
@@ -0,0 +1,107 @@
|
|
1
|
+
# Wire4Client::EmpresasCoDiApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**obtain_companies**](EmpresasCoDiApi.md#obtain_companies) | **GET** /codi/companies | Consulta de empresas CODI
|
8
|
+
[**register_company_using_post**](EmpresasCoDiApi.md#register_company_using_post) | **POST** /codi/companies | Registro de empresas CODI
|
9
|
+
|
10
|
+
|
11
|
+
# **obtain_companies**
|
12
|
+
> Array<CompanyRegistered> obtain_companies(authorization)
|
13
|
+
|
14
|
+
Consulta de empresas CODI
|
15
|
+
|
16
|
+
Consulta de empresas CODI registradas para la aplicación.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'wire4_client'
|
22
|
+
|
23
|
+
api_instance = Wire4Client::EmpresasCoDiApi.new
|
24
|
+
|
25
|
+
authorization = 'authorization_example' # String | Header para token
|
26
|
+
|
27
|
+
|
28
|
+
begin
|
29
|
+
#Consulta de empresas CODI
|
30
|
+
result = api_instance.obtain_companies(authorization)
|
31
|
+
p result
|
32
|
+
rescue Wire4Client::ApiError => e
|
33
|
+
puts "Exception when calling EmpresasCoDiApi->obtain_companies: #{e}"
|
34
|
+
end
|
35
|
+
```
|
36
|
+
|
37
|
+
### Parameters
|
38
|
+
|
39
|
+
Name | Type | Description | Notes
|
40
|
+
------------- | ------------- | ------------- | -------------
|
41
|
+
**authorization** | **String**| Header para token |
|
42
|
+
|
43
|
+
### Return type
|
44
|
+
|
45
|
+
[**Array<CompanyRegistered>**](CompanyRegistered.md)
|
46
|
+
|
47
|
+
### Authorization
|
48
|
+
|
49
|
+
No authorization required
|
50
|
+
|
51
|
+
### HTTP request headers
|
52
|
+
|
53
|
+
- **Content-Type**: Not defined
|
54
|
+
- **Accept**: application/json
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
# **register_company_using_post**
|
59
|
+
> CompanyRegistered register_company_using_post(authorization, request_dto)
|
60
|
+
|
61
|
+
Registro de empresas CODI
|
62
|
+
|
63
|
+
Registra una empresa para hacer uso de operaciones CODI. Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y RFC de la empresa.<br/>
|
64
|
+
|
65
|
+
### Example
|
66
|
+
```ruby
|
67
|
+
# load the gem
|
68
|
+
require 'wire4_client'
|
69
|
+
|
70
|
+
api_instance = Wire4Client::EmpresasCoDiApi.new
|
71
|
+
|
72
|
+
authorization = 'authorization_example' # String | Header para token
|
73
|
+
|
74
|
+
request_dto = Wire4Client::CompanyRequested.new # CompanyRequested | Información de la cuenta del beneficiario
|
75
|
+
|
76
|
+
|
77
|
+
begin
|
78
|
+
#Registro de empresas CODI
|
79
|
+
result = api_instance.register_company_using_post(authorization, request_dto)
|
80
|
+
p result
|
81
|
+
rescue Wire4Client::ApiError => e
|
82
|
+
puts "Exception when calling EmpresasCoDiApi->register_company_using_post: #{e}"
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
### Parameters
|
87
|
+
|
88
|
+
Name | Type | Description | Notes
|
89
|
+
------------- | ------------- | ------------- | -------------
|
90
|
+
**authorization** | **String**| Header para token |
|
91
|
+
**request_dto** | [**CompanyRequested**](CompanyRequested.md)| Información de la cuenta del beneficiario |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
[**CompanyRegistered**](CompanyRegistered.md)
|
96
|
+
|
97
|
+
### Authorization
|
98
|
+
|
99
|
+
No authorization required
|
100
|
+
|
101
|
+
### HTTP request headers
|
102
|
+
|
103
|
+
- **Content-Type**: application/json
|
104
|
+
- **Accept**: application/json
|
105
|
+
|
106
|
+
|
107
|
+
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**account** | **String** | Cuenta del beneficiario | [optional]
|
6
|
+
**account** | **String** | Cuenta del beneficiario registrado | [optional]
|
7
7
|
**error_message** | **String** | Mensaje de error en caso de existir, el valor de este atributo contiene el mensaje | [optional]
|
8
|
-
**request_id** | **String** | El identificador
|
8
|
+
**request_id** | **String** | El identificador en esta API, de la petición de registro de la cuenta del beneficiario | [optional]
|
9
9
|
|
10
10
|
|
data/docs/MessageCEP.md
CHANGED
@@ -6,23 +6,23 @@ Name | Type | Description | Notes
|
|
6
6
|
**account_beneficiary** | **String** | Cuenta del beneficiario | [optional]
|
7
7
|
**account_sender** | **String** | Cuenta que envia la operación | [optional]
|
8
8
|
**amount** | **Float** | Monto de la operación | [optional]
|
9
|
-
**available** | **BOOLEAN** |
|
9
|
+
**available** | **BOOLEAN** | Indica sí el CEP está disponible | [optional]
|
10
10
|
**bank_beneficiary** | **String** | Clave del banco beneficiario | [optional]
|
11
|
-
**bank_sender** | **String** | Clave del banco que
|
11
|
+
**bank_sender** | **String** | Clave del banco que envía la operación | [optional]
|
12
12
|
**beneficiary_name** | **String** | Nombre del beneficiario | [optional]
|
13
13
|
**beneficiary_rfc** | **String** | RFC del beneficiario | [optional]
|
14
14
|
**cadena_original** | **String** | Cadena original emita por el SAT | [optional]
|
15
15
|
**capture_date** | **DateTime** | Fecha de captura | [optional]
|
16
|
-
**certificate_serial_number** | **String** |
|
16
|
+
**certificate_serial_number** | **String** | Número de serie emitido por el SAT | [optional]
|
17
17
|
**clave_rastreo** | **String** | Clave de rastreo de la operación | [optional]
|
18
18
|
**description** | **String** | Descripción de la operación | [optional]
|
19
|
-
**iva** | **Float** |
|
19
|
+
**iva** | **Float** | IVA de la operación | [optional]
|
20
20
|
**operation_date** | **DateTime** | Fecha en la que se realizó la operación | [optional]
|
21
|
-
**operation_date_cep** | **DateTime** | Fecha en la que genera el
|
21
|
+
**operation_date_cep** | **DateTime** | Fecha en la que genera el CEP | [optional]
|
22
22
|
**reference** | **String** | Referencia de la operación | [optional]
|
23
|
-
**sender_name** | **String** | Nombre de
|
24
|
-
**sender_rfc** | **String** | RFC de
|
25
|
-
**signature** | **String** | Firma del
|
26
|
-
**url_zip** | **String** |
|
23
|
+
**sender_name** | **String** | Nombre de quién envía la operación | [optional]
|
24
|
+
**sender_rfc** | **String** | RFC de quién envía la operación | [optional]
|
25
|
+
**signature** | **String** | Firma del CEP | [optional]
|
26
|
+
**url_zip** | **String** | Dirección URL de descarga del archivo ZIP que contiene el PDF y XML del CEP proporcionado por BANXICO | [optional]
|
27
27
|
|
28
28
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Wire4Client::MessageCodiAction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**amount** | **Float** | Monto de la operación de pago | [optional]
|
7
|
+
**concept** | **String** | Concepto | [optional]
|
8
|
+
**due_date** | **DateTime** | Fecha de expiración de la operación | [optional]
|
9
|
+
**id** | **String** | Uuid de la operación | [optional]
|
10
|
+
**metadata** | **String** | Metadata asociada a la petición de pago | [optional]
|
11
|
+
**operation_date** | **DateTime** | Fecha de la operación | [optional]
|
12
|
+
**order_id** | **String** | Identificador de la petición | [optional]
|
13
|
+
**payment_type** | **String** | Tipo de pago | [optional]
|
14
|
+
**reference** | **String** | Número de referencia | [optional]
|
15
|
+
**sales_point_id** | **String** | Identidicador del punto de venta a la que pertenece la petición de pago | [optional]
|
16
|
+
**status** | **String** | Estado de la operación de pago | [optional]
|
17
|
+
**transaction_id** | **String** | Id de la transacción | [optional]
|
18
|
+
|
19
|
+
|
data/docs/MessagePayment.md
CHANGED
@@ -8,15 +8,17 @@ Name | Type | Description | Notes
|
|
8
8
|
**beneficiary_account** | **String** | Cuenta del beneficiario | [optional]
|
9
9
|
**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional]
|
10
10
|
**beneficiary_name** | **String** | Nombre del beneficiario | [optional]
|
11
|
-
**cep** | [**MessageCEP**](MessageCEP.md) |
|
11
|
+
**cep** | [**MessageCEP**](MessageCEP.md) | Informacion del CEP | [optional]
|
12
12
|
**clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional]
|
13
13
|
**concept** | **String** | Concepto de la transferencia de salida | [optional]
|
14
14
|
**confirm_date** | **DateTime** | Fecha de confirmación de la transferencia de salida | [optional]
|
15
15
|
**currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional]
|
16
16
|
**detention_message** | **String** | Mensaje de detención de Monex de la transferencia de salida | [optional]
|
17
|
+
**error_message** | **String** | Mensaje de error | [optional]
|
17
18
|
**monex_description** | **String** | La descripción de Monex de la transferencia de salida | [optional]
|
18
19
|
**order_id** | **String** | El identificador de la transferencia de salida | [optional]
|
19
20
|
**payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional]
|
21
|
+
**pending_reason** | **String** | Razón de porque está pendiente aún cuando se autorizó la transferencia | [optional]
|
20
22
|
**reference** | **Integer** | Referecia de la transferencia | [optional]
|
21
23
|
**request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional]
|
22
24
|
**status_code** | **String** | El estado de la transferencia de salida | [optional]
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# Wire4Client::MessagePaymentStatePending
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account** | **String** | Cuenta del ordenante | [optional]
|
7
|
+
**amount** | **Float** | Monto de la transferencia | [optional]
|
8
|
+
**beneficiary_account** | **String** | Cuenta del beneficiario | [optional]
|
9
|
+
**beneficiary_bank** | [**MessageInstitution**](MessageInstitution.md) | Banco del beneficiario | [optional]
|
10
|
+
**beneficiary_name** | **String** | Nombre del beneficiario | [optional]
|
11
|
+
**concept** | **String** | Concepto de la transferencia de salida | [optional]
|
12
|
+
**currency_code** | **String** | Código de la moneda de la transferencia de salida | [optional]
|
13
|
+
**detention_message** | **String** | Mensaje de detención de Monex, indica la causa por la cuál esta detenida la operación en Monex | [optional]
|
14
|
+
**error_message** | **String** | Mensaje de error | [optional]
|
15
|
+
**order_id** | **String** | El identificador de la transferencia de salida | [optional]
|
16
|
+
**payment_order_id** | **Integer** | El identificador de la orden de pago de Monex de la transferencia de salida | [optional]
|
17
|
+
**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]
|
18
|
+
**reference** | **Integer** | Referecia de la transferencia | [optional]
|
19
|
+
**request_id** | **String** | El identificador, en esta API, de la petición de envío de la transferencia de salida | [optional]
|
20
|
+
**status_code** | **String** | El estado de la transferencia de salida, deberá ser PENDING | [optional]
|
21
|
+
**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]
|
22
|
+
|
23
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**request_id** | **String** | Identificador de la petición realizada a
|
7
|
-
**status** | **String** | El cambio a informar en la procesamiento de la petición | [optional]
|
6
|
+
**request_id** | **String** | Identificador de la petición realizada a esta API | [optional]
|
7
|
+
**status** | **String** | El cambio a informar en la procesamiento/estado de la petición | [optional]
|
8
8
|
|
9
9
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Wire4Client::MessageSalesPoint
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account** | **String** | Cuenta donde se realziaran los pagos | [optional]
|
7
|
+
**ip** | **String** | Ip desde la cual se accedera al API | [optional]
|
8
|
+
**name** | **String** | Nombre del punto de venta | [optional]
|
9
|
+
|
10
|
+
|
data/docs/MessageSubscription.md
CHANGED
@@ -3,11 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**contract** | **String** | Contrato Monex, con el
|
7
|
-
**masked_contract** | **String** | Contrato enmascarado de Monex, con el
|
8
|
-
**subscription** | **String** | Identificador de la suscripción, el cual se
|
9
|
-
**user** | **String** | Usuario enmascardo, con el
|
10
|
-
**user_key** | **String** | Usuario proporcionado por Wire4, el
|
11
|
-
**user_secret** | **String** | Contraseña proporcionada por Wire4, la
|
6
|
+
**contract** | **String** | Contrato Monex, con el cuál se suscribió el cliente Monex en Wire4 | [optional]
|
7
|
+
**masked_contract** | **String** | Contrato enmascarado de Monex, con el cuál se suscribió el cliente Monex en Wire4 | [optional]
|
8
|
+
**subscription** | **String** | Identificador de la suscripción, el cual se utilizará en las operaciones que solicitan una suscripción | [optional]
|
9
|
+
**user** | **String** | Usuario enmascardo, con el cuál se suscribió el cliente Monex en Wire4 | [optional]
|
10
|
+
**user_key** | **String** | Usuario proporcionado por Wire4, el cuál se debe utilizar para autenticar a esta suscripción | [optional]
|
11
|
+
**user_secret** | **String** | Contraseña proporcionada por Wire4, la cuál se debe utilizar para autenticar a esta suscripción | [optional]
|
12
12
|
|
13
13
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Wire4Client::MessageUserAuthorized
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**account** | **String** | El contrato al cual se le brinda el acceso a la API | [optional]
|
7
|
+
**masked_account** | **String** | El contrato enmascarado al cual se le brinda el acceso a la API | [optional]
|
8
|
+
**masked_name** | **String** | El usuario enmascarado que se autorizó | [optional]
|
9
|
+
**masked_user_name** | **String** | El nombre enmascarado del usuario de acceso que se autorizó | [optional]
|
10
|
+
**name** | **String** | El usuario que se autorizó | [optional]
|
11
|
+
**request_id** | **String** | El identificador de la petición cuando se solicitó la autorización | [optional]
|
12
|
+
|
13
|
+
|
data/docs/MessageWebHook.md
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**api_version** | **String** | La versión de
|
6
|
+
**api_version** | **String** | La versión de esta API | [optional]
|
7
7
|
**created** | **DateTime** | Fecha de creación del mensaje | [optional]
|
8
8
|
**data** | **Object** | Objeto que contiene la información del evento | [optional]
|
9
9
|
**id** | **String** | El identificador del mensaje | [optional]
|
10
10
|
**livemode** | **BOOLEAN** | Indica si proviene de un entorno productivo | [optional]
|
11
|
-
**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]
|
11
|
+
**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]
|
12
12
|
**pending_webhooks** | **Integer** | Número de mensajes pendientes de enviar | [optional]
|
13
13
|
**request** | **String** | Identificador del recurso relacionado | [optional]
|
14
14
|
**type** | **String** | El tipo evento que se esta enviando en la notifiación | [optional]
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# Wire4Client::OperacionesCoDiApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**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
|
8
|
+
|
9
|
+
|
10
|
+
# **consult_codi_operations**
|
11
|
+
> PagerResponseDto consult_codi_operations(authorization, opts)
|
12
|
+
|
13
|
+
Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
14
|
+
|
15
|
+
Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'wire4_client'
|
21
|
+
|
22
|
+
api_instance = Wire4Client::OperacionesCoDiApi.new
|
23
|
+
|
24
|
+
authorization = 'authorization_example' # String | Header para token
|
25
|
+
|
26
|
+
opts = {
|
27
|
+
company_id: 'company_id_example', # String | Identificador de empresa CoDi
|
28
|
+
page: '0', # String | Número de pago
|
29
|
+
request_filters: Wire4Client::CodiOperationsFiltersRequestDTO.new, # CodiOperationsFiltersRequestDTO | Filtros de busqueda
|
30
|
+
sales_point_id: 'sales_point_id_example', # String | Identificador del punto de venta
|
31
|
+
size: '20' # String | Tamaño de pagina
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
|
36
|
+
result = api_instance.consult_codi_operations(authorization, opts)
|
37
|
+
p result
|
38
|
+
rescue Wire4Client::ApiError => e
|
39
|
+
puts "Exception when calling OperacionesCoDiApi->consult_codi_operations: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**authorization** | **String**| Header para token |
|
48
|
+
**company_id** | **String**| Identificador de empresa CoDi | [optional]
|
49
|
+
**page** | **String**| Número de pago | [optional] [default to 0]
|
50
|
+
**request_filters** | [**CodiOperationsFiltersRequestDTO**](CodiOperationsFiltersRequestDTO.md)| Filtros de busqueda | [optional]
|
51
|
+
**sales_point_id** | **String**| Identificador del punto de venta | [optional]
|
52
|
+
**size** | **String**| Tamaño de pagina | [optional] [default to 20]
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**PagerResponseDto**](PagerResponseDto.md)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
No authorization required
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: application/json
|
65
|
+
- **Accept**: application/json
|
66
|
+
|
67
|
+
|
68
|
+
|