wire4_client 1.0.5 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +51 -30
- data/docs/Account.md +11 -11
- data/docs/AccountReassigned.md +14 -14
- data/docs/AccountRequest.md +3 -3
- data/docs/AccountResponse.md +13 -13
- data/docs/AccountSpid.md +11 -11
- data/docs/AmountRequest.md +5 -5
- data/docs/AuthorizationTransactionGroup.md +2 -2
- data/docs/AuthorizedBeneficiariesResponse.md +3 -3
- data/docs/AutorizacinDeDepsitosApi.md +113 -0
- data/docs/Balance.md +3 -3
- data/docs/BalanceListResponse.md +1 -1
- data/docs/BeneficiariesQueryRegisterStatus.md +2 -2
- data/docs/BeneficiariesResponse.md +1 -1
- data/docs/BillingTransaction.md +1 -1
- data/docs/CepResponse.md +20 -20
- data/docs/CepSearchBanxico.md +8 -8
- data/docs/CertificateRequest.md +4 -4
- data/docs/CodiCodeQrResponseDTO.md +10 -10
- data/docs/CodiOperationResponseDTO.md +7 -7
- data/docs/CodiOperationsFiltersRequestDTO.md +8 -8
- data/docs/CompanyRegistered.md +6 -6
- data/docs/CompanyRequested.md +4 -4
- data/docs/ConfigurationsLimits.md +9 -0
- data/docs/ContactRequest.md +5 -5
- data/docs/ContractsDetailsApi.md +55 -0
- data/docs/CuentasDeBeneficiariosSPEIApi.md +54 -54
- data/docs/CuentasDeBeneficiariosSPIDApi.md +24 -22
- data/docs/Deposit.md +22 -21
- data/docs/DepositAuthorizationRequest.md +10 -0
- data/docs/Depositant.md +5 -5
- data/docs/DepositantesApi.md +6 -6
- data/docs/DepositantsRegister.md +4 -4
- data/docs/DepositantsResponse.md +1 -1
- data/docs/DepositsAuthorizationResponse.md +10 -0
- data/docs/DetailedErrorResponse.md +10 -0
- data/docs/EmpresasCoDiApi.md +8 -8
- data/docs/GetDepositants.md +1 -1
- data/docs/InstitucionesApi.md +5 -3
- data/docs/Institution.md +4 -4
- data/docs/InstitutionsList.md +1 -1
- data/docs/Item.md +10 -0
- data/docs/LmitesDeMontosApi.md +112 -0
- data/docs/MessageAccountBeneficiary.md +3 -3
- data/docs/MessageCEP.md +19 -19
- data/docs/MessageCodiAction.md +12 -12
- data/docs/MessageConfigurationsLimits.md +8 -0
- data/docs/MessageDepositAuthorizationRequest.md +28 -0
- data/docs/MessageDepositReceived.md +22 -21
- data/docs/MessageInstitution.md +4 -4
- data/docs/MessagePayment.md +20 -20
- data/docs/MessagePaymentStatePending.md +16 -16
- data/docs/MessageRequestChanged.md +2 -2
- data/docs/MessageSalesPoint.md +3 -3
- data/docs/MessageSubscription.md +6 -6
- data/docs/MessageUserAuthorized.md +7 -6
- data/docs/MessageWebHook.md +9 -9
- data/docs/OperacionesCoDiApi.md +12 -12
- data/docs/Operations.md +8 -8
- data/docs/PagerResponseDto.md +6 -6
- data/docs/Payment.md +19 -19
- data/docs/PaymentCODI.md +13 -0
- data/docs/PaymentRequestCodiResponseDTO.md +11 -11
- data/docs/PeticionesDePagoPorCoDiApi.md +7 -7
- data/docs/PreEnrollmentData.md +2 -2
- data/docs/PreEnrollmentResponse.md +2 -2
- data/docs/PuntosDeVentaCoDiApi.md +14 -14
- data/docs/Relationship.md +2 -2
- data/docs/RelationshipsResponse.md +1 -1
- data/docs/SaldoApi.md +3 -3
- data/docs/SalesPointFound.md +7 -7
- data/docs/SalesPointRequest.md +4 -4
- data/docs/SalesPointRespose.md +4 -4
- data/docs/ServiceBanking.md +9 -0
- data/docs/SpidBeneficiariesResponse.md +1 -1
- data/docs/SpidBeneficiaryResponse.md +11 -11
- data/docs/SpidClassificationDTO.md +2 -2
- data/docs/SubscriptionChangeStatusRequest.md +8 -0
- data/docs/SuscripcionesApi.md +123 -16
- data/docs/TokenRequiredResponse.md +2 -2
- data/docs/TransactionErrorCode.md +10 -0
- data/docs/TransactionOutgoingSpid.md +10 -10
- data/docs/TransactionsOutgoingRegister.md +3 -3
- data/docs/TransferenciasSPEIApi.md +40 -34
- data/docs/TransferenciasSPIDApi.md +12 -12
- data/docs/UpdateConfigurationsRequestDTO.md +8 -0
- data/docs/UrlsRedirect.md +2 -2
- data/docs/UseServiceBanking.md +9 -0
- data/docs/WebHookDepositAuthorizationRequest.md +9 -0
- data/docs/WebHookDepositAuthorizationResponse.md +13 -0
- data/docs/Webhook.md +6 -6
- data/docs/WebhookRequest.md +3 -3
- data/docs/WebhookResponse.md +5 -5
- data/docs/WebhooksApi.md +10 -10
- data/lib/wire4_client/api/autorizacin_de_depsitos_api.rb +173 -0
- data/lib/wire4_client/api/contracts_details_api.rb +71 -0
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +56 -56
- data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +24 -22
- data/lib/wire4_client/api/depositantes_api.rb +79 -8
- data/lib/wire4_client/api/empresas_co_di_api.rb +8 -8
- data/lib/wire4_client/api/instituciones_api.rb +4 -2
- data/lib/wire4_client/api/lmites_de_montos_api.rb +160 -0
- data/lib/wire4_client/api/operaciones_co_di_api.rb +12 -12
- data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +6 -6
- data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +14 -14
- data/lib/wire4_client/api/saldo_api.rb +4 -4
- data/lib/wire4_client/api/suscripciones_api.rb +149 -16
- data/lib/wire4_client/api/transferencias_spei_api.rb +72 -42
- data/lib/wire4_client/api/transferencias_spid_api.rb +12 -12
- data/lib/wire4_client/api/webhooks_api.rb +15 -15
- data/lib/wire4_client/models/account.rb +11 -11
- data/lib/wire4_client/models/account_detail.rb +1 -1
- data/lib/wire4_client/models/account_reassigned.rb +15 -15
- data/lib/wire4_client/models/account_request.rb +3 -3
- data/lib/wire4_client/models/account_response.rb +14 -14
- data/lib/wire4_client/models/account_spid.rb +59 -11
- data/lib/wire4_client/models/amount_request.rb +6 -6
- data/lib/wire4_client/models/authorization_transaction_group.rb +2 -2
- data/lib/wire4_client/models/authorized_beneficiaries_response.rb +3 -3
- data/lib/wire4_client/models/balance.rb +4 -4
- data/lib/wire4_client/models/balance_list_response.rb +1 -1
- data/lib/wire4_client/models/beneficiaries_query_register_status.rb +2 -2
- data/lib/wire4_client/models/beneficiaries_response.rb +1 -1
- data/lib/wire4_client/models/billing_transaction.rb +1 -1
- data/lib/wire4_client/models/cep_response.rb +20 -20
- data/lib/wire4_client/models/cep_search_banxico.rb +8 -8
- data/lib/wire4_client/models/certificate_request.rb +5 -5
- data/lib/wire4_client/models/codi_code_qr_response_dto.rb +10 -10
- data/lib/wire4_client/models/codi_operation_response_dto.rb +7 -7
- data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +8 -8
- data/lib/wire4_client/models/company_registered.rb +6 -6
- data/lib/wire4_client/models/company_requested.rb +5 -5
- data/lib/wire4_client/models/configurations_limits.rb +197 -0
- data/lib/wire4_client/models/contact_request.rb +6 -6
- data/lib/wire4_client/models/deposit.rb +32 -22
- data/lib/wire4_client/models/deposit_authorization_request.rb +205 -0
- data/lib/wire4_client/models/depositant.rb +5 -5
- data/lib/wire4_client/models/depositant_count_response.rb +185 -0
- data/lib/wire4_client/models/depositants_register.rb +4 -4
- data/lib/wire4_client/models/depositants_response.rb +1 -1
- data/lib/wire4_client/models/deposits_authorization_response.rb +205 -0
- data/lib/wire4_client/models/detailed_error_response.rb +203 -0
- data/lib/wire4_client/models/get_depositants.rb +2 -2
- data/lib/wire4_client/models/institution.rb +5 -5
- data/lib/wire4_client/models/institutions_list.rb +1 -1
- data/lib/wire4_client/models/item.rb +205 -0
- data/lib/wire4_client/models/message_account_beneficiary.rb +4 -4
- data/lib/wire4_client/models/message_cep.rb +20 -20
- data/lib/wire4_client/models/message_codi_action.rb +13 -13
- data/lib/wire4_client/models/message_configurations_limits.rb +187 -0
- data/lib/wire4_client/models/message_deposit_authorization_request.rb +385 -0
- data/lib/wire4_client/models/message_deposit_received.rb +33 -23
- data/lib/wire4_client/models/message_institution.rb +5 -5
- data/lib/wire4_client/models/message_payment.rb +21 -21
- data/lib/wire4_client/models/message_payment_state_pending.rb +17 -17
- data/lib/wire4_client/models/message_request_changed.rb +3 -3
- data/lib/wire4_client/models/message_sales_point.rb +4 -4
- data/lib/wire4_client/models/message_subscription.rb +7 -7
- data/lib/wire4_client/models/message_user_authorized.rb +21 -11
- data/lib/wire4_client/models/message_web_hook.rb +10 -10
- data/lib/wire4_client/models/operations.rb +9 -9
- data/lib/wire4_client/models/pager_response_dto.rb +6 -6
- data/lib/wire4_client/models/payment.rb +19 -19
- data/lib/wire4_client/models/payment_codi.rb +269 -0
- data/lib/wire4_client/models/payment_request_codi_response_dto.rb +11 -11
- data/lib/wire4_client/models/pre_enrollment_data.rb +20 -2
- data/lib/wire4_client/models/pre_enrollment_response.rb +2 -2
- data/lib/wire4_client/models/relationship.rb +2 -2
- data/lib/wire4_client/models/relationships_response.rb +1 -1
- data/lib/wire4_client/models/sales_point_found.rb +10 -10
- data/lib/wire4_client/models/sales_point_request.rb +5 -5
- data/lib/wire4_client/models/sales_point_respose.rb +5 -5
- data/lib/wire4_client/models/service_banking.rb +193 -0
- data/lib/wire4_client/models/spid_beneficiaries_response.rb +1 -1
- data/lib/wire4_client/models/spid_beneficiary_response.rb +11 -11
- data/lib/wire4_client/models/spid_classification_dto.rb +2 -2
- data/lib/wire4_client/models/subscription_change_status_request.rb +222 -0
- data/lib/wire4_client/models/token_required_response.rb +3 -3
- data/lib/wire4_client/models/transaction_error_code.rb +201 -0
- data/lib/wire4_client/models/transaction_outgoing_spid.rb +11 -11
- data/lib/wire4_client/models/transactions_outgoing_register.rb +4 -4
- data/lib/wire4_client/models/update_configurations_request_dto.rb +192 -0
- data/lib/wire4_client/models/urls_redirect.rb +59 -3
- data/lib/wire4_client/models/use_service_banking.rb +251 -0
- data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +195 -0
- data/lib/wire4_client/models/{timestamp.rb → web_hook_deposit_authorization_response.rb} +47 -74
- data/lib/wire4_client/models/webhook.rb +7 -7
- data/lib/wire4_client/models/webhook_request.rb +3 -3
- data/lib/wire4_client/models/webhook_response.rb +5 -5
- data/lib/wire4_client/version.rb +1 -1
- data/lib/wire4_client.rb +18 -1
- data/spec/api/autorizacin_de_depsitos_api_spec.rb +62 -0
- data/spec/api/contracts_details_api_spec.rb +14 -0
- data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +28 -28
- data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +12 -11
- data/spec/api/depositantes_api_spec.rb +4 -4
- data/spec/api/empresas_co_di_api_spec.rb +4 -4
- data/spec/api/instituciones_api_spec.rb +2 -1
- data/spec/api/lmites_de_montos_api_spec.rb +62 -0
- data/spec/api/operaciones_co_di_api_spec.rb +6 -6
- data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +3 -3
- data/spec/api/puntos_de_venta_co_di_api_spec.rb +7 -7
- data/spec/api/saldo_api_spec.rb +2 -2
- data/spec/api/suscripciones_api_spec.rb +36 -8
- data/spec/api/transferencias_spei_api_spec.rb +19 -17
- data/spec/api/transferencias_spid_api_spec.rb +6 -6
- data/spec/api/webhooks_api_spec.rb +4 -4
- data/spec/models/configurations_limits_spec.rb +47 -0
- data/spec/models/deposit_authorization_request_spec.rb +53 -0
- data/spec/models/deposit_spec.rb +6 -0
- data/spec/models/deposits_authorization_response_spec.rb +53 -0
- data/spec/models/detailed_error_response_spec.rb +53 -0
- data/spec/models/item_spec.rb +53 -0
- data/spec/models/message_configurations_limits_spec.rb +41 -0
- data/spec/models/message_deposit_authorization_request_spec.rb +161 -0
- data/spec/models/message_deposit_received_spec.rb +6 -0
- data/spec/models/message_user_authorized_spec.rb +6 -0
- data/spec/models/{timestamp_spec.rb → payment_codi_spec.rb} +16 -36
- data/spec/models/service_banking_spec.rb +47 -0
- data/spec/models/subscription_change_status_request_spec.rb +45 -0
- data/spec/models/transaction_error_code_spec.rb +53 -0
- data/spec/models/update_configurations_request_dto_spec.rb +41 -0
- data/spec/models/use_service_banking_spec.rb +55 -0
- data/spec/models/web_hook_deposit_authorization_request_spec.rb +47 -0
- data/spec/models/web_hook_deposit_authorization_response_spec.rb +71 -0
- metadata +72 -7
- data/docs/Timestamp.md +0 -17
|
@@ -4,16 +4,16 @@ 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
|
-
[**create_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint |
|
|
8
|
-
[**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint |
|
|
7
|
+
[**create_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint | Registro de punto de venta.
|
|
8
|
+
[**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint | Consulta de puntos de venta
|
|
9
9
|
|
|
10
10
|
|
|
11
11
|
# **create_sales_point**
|
|
12
12
|
> SalesPointRespose create_sales_point(authorization, company_id, sales_point_info)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
Registro de punto de venta.
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Se registra un punto de venta (TPV) desde donde se emitarán los cobros CODI®. El punto de venta se debe asociar a un cuenta CLABE registrada previamente ante Banxico para realizar cobros con CODI®.
|
|
17
17
|
|
|
18
18
|
### Example
|
|
19
19
|
```ruby
|
|
@@ -24,13 +24,13 @@ api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
|
|
|
24
24
|
|
|
25
25
|
authorization = 'authorization_example' # String | Header para token
|
|
26
26
|
|
|
27
|
-
company_id = 'company_id_example' # String |
|
|
27
|
+
company_id = 'company_id_example' # String | Es el identificador de la empresa.
|
|
28
28
|
|
|
29
|
-
sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest |
|
|
29
|
+
sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest | Es el objeto que contiene información del punto de venta CODI®.
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
begin
|
|
33
|
-
#
|
|
33
|
+
#Registro de punto de venta.
|
|
34
34
|
result = api_instance.create_sales_point(authorization, company_id, sales_point_info)
|
|
35
35
|
p result
|
|
36
36
|
rescue Wire4Client::ApiError => e
|
|
@@ -43,8 +43,8 @@ end
|
|
|
43
43
|
Name | Type | Description | Notes
|
|
44
44
|
------------- | ------------- | ------------- | -------------
|
|
45
45
|
**authorization** | **String**| Header para token |
|
|
46
|
-
**company_id** | **String**|
|
|
47
|
-
**sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)|
|
|
46
|
+
**company_id** | **String**| Es el identificador de la empresa. |
|
|
47
|
+
**sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)| Es el objeto que contiene información del punto de venta CODI®. |
|
|
48
48
|
|
|
49
49
|
### Return type
|
|
50
50
|
|
|
@@ -64,9 +64,9 @@ No authorization required
|
|
|
64
64
|
# **obtain_sale_points**
|
|
65
65
|
> Array<SalesPointFound> obtain_sale_points(authorization, company_id)
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
Consulta de puntos de venta
|
|
68
68
|
|
|
69
|
-
Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI
|
|
69
|
+
Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®.
|
|
70
70
|
|
|
71
71
|
### Example
|
|
72
72
|
```ruby
|
|
@@ -77,11 +77,11 @@ api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
|
|
|
77
77
|
|
|
78
78
|
authorization = 'authorization_example' # String | Header para token
|
|
79
79
|
|
|
80
|
-
company_id = 'company_id_example' # String |
|
|
80
|
+
company_id = 'company_id_example' # String | Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
begin
|
|
84
|
-
#
|
|
84
|
+
#Consulta de puntos de venta
|
|
85
85
|
result = api_instance.obtain_sale_points(authorization, company_id)
|
|
86
86
|
p result
|
|
87
87
|
rescue Wire4Client::ApiError => e
|
|
@@ -94,7 +94,7 @@ end
|
|
|
94
94
|
Name | Type | Description | Notes
|
|
95
95
|
------------- | ------------- | ------------- | -------------
|
|
96
96
|
**authorization** | **String**| Header para token |
|
|
97
|
-
**company_id** | **String**|
|
|
97
|
+
**company_id** | **String**| Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed |
|
|
98
98
|
|
|
99
99
|
### Return type
|
|
100
100
|
|
data/docs/Relationship.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**kind_of_relationship** | **String** |
|
|
7
|
-
**relationship** | **String** |
|
|
6
|
+
**kind_of_relationship** | **String** | Es el tipo de relación. | [optional]
|
|
7
|
+
**relationship** | **String** | Es el mombre de la relación. | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**relationships** | [**Array<Relationship>**](Relationship.md) |
|
|
6
|
+
**relationships** | [**Array<Relationship>**](Relationship.md) | Es una lista de relaciones del beneficiario. | [optional]
|
|
7
7
|
|
|
8
8
|
|
data/docs/SaldoApi.md
CHANGED
|
@@ -12,7 +12,7 @@ Method | HTTP request | Description
|
|
|
12
12
|
|
|
13
13
|
Consulta los saldo de una cuenta
|
|
14
14
|
|
|
15
|
-
Obtiene el de las divisas que se manejen en
|
|
15
|
+
Obtiene el saldo de un contrato, según las divisas que se manejen en dicho contrato, ya sea peso mexicano (MXP) o dólar estadounidense (USD).
|
|
16
16
|
|
|
17
17
|
### Example
|
|
18
18
|
```ruby
|
|
@@ -23,7 +23,7 @@ api_instance = Wire4Client::SaldoApi.new
|
|
|
23
23
|
|
|
24
24
|
authorization = 'authorization_example' # String | Header para token
|
|
25
25
|
|
|
26
|
-
subscription = 'subscription_example' # String |
|
|
26
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
|
27
27
|
|
|
28
28
|
|
|
29
29
|
begin
|
|
@@ -40,7 +40,7 @@ end
|
|
|
40
40
|
Name | Type | Description | Notes
|
|
41
41
|
------------- | ------------- | ------------- | -------------
|
|
42
42
|
**authorization** | **String**| Header para token |
|
|
43
|
-
**subscription** | **String**|
|
|
43
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
|
44
44
|
|
|
45
45
|
### Return type
|
|
46
46
|
|
data/docs/SalesPointFound.md
CHANGED
|
@@ -3,12 +3,12 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**access_ip** | **String** |
|
|
7
|
-
**account** | **String** |
|
|
8
|
-
**created_at** |
|
|
9
|
-
**name** | **String** |
|
|
10
|
-
**public_id** | **String** |
|
|
11
|
-
**status** | **String** |
|
|
12
|
-
**updated_at** |
|
|
6
|
+
**access_ip** | **String** | Es la dirección IP desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones. | [optional]
|
|
7
|
+
**account** | **String** | Es la cuenta registra para el punto de venta. | [optional]
|
|
8
|
+
**created_at** | **DateTime** | Es la fecha en la que se creó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
|
|
9
|
+
**name** | **String** | Es el nombre del punto de venta. | [optional]
|
|
10
|
+
**public_id** | **String** | Es el identificador del punto de venta. | [optional]
|
|
11
|
+
**status** | **String** | Es el estado (estatus) del punto de venta. Puede ser \"ACTIVE\" o \"INACTIVO\". | [optional]
|
|
12
|
+
**updated_at** | **DateTime** | Es la fecha en la que se actualizó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
|
|
13
13
|
|
|
14
14
|
|
data/docs/SalesPointRequest.md
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**access_ip** | **String** | IP desde donde se
|
|
7
|
-
**account** | **String** |
|
|
8
|
-
**name** | **String** |
|
|
9
|
-
**notifications_url** | **String** | URL para envíar notificaciones
|
|
6
|
+
**access_ip** | **String** | Es la dirección IP desde donde se recibirán las peticiones de este punto de venta |
|
|
7
|
+
**account** | **String** | Es el número de cuenta CLABE donde se realizará el deposito del cobro CODI®. |
|
|
8
|
+
**name** | **String** | Es el nombre del punto de venta. |
|
|
9
|
+
**notifications_url** | **String** | Es la dirección URL para envíar notificaciones CODI® al punto de venta. |
|
|
10
10
|
|
|
11
11
|
|
data/docs/SalesPointRespose.md
CHANGED
|
@@ -3,9 +3,9 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**sales_point_id** | **String** |
|
|
7
|
-
**user_key** | **String** |
|
|
8
|
-
**user_secret** | **String** |
|
|
9
|
-
**webhook** | [**Webhook**](Webhook.md) |
|
|
6
|
+
**sales_point_id** | **String** | Es el identificador del punto de venta. | [optional]
|
|
7
|
+
**user_key** | **String** | Es la llave de usuario para el API Wire4. Sólo para el uso de CODI®. | [optional]
|
|
8
|
+
**user_secret** | **String** | Es la contraseña para el API Wire4. Sólo para el uso de CODI®. | [optional]
|
|
9
|
+
**webhook** | [**Webhook**](Webhook.md) | codiWebhook | [optional]
|
|
10
10
|
|
|
11
11
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Wire4Client::ServiceBanking
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**spei** | [**UseServiceBanking**](UseServiceBanking.md) | | [optional]
|
|
7
|
+
**spid** | [**UseServiceBanking**](UseServiceBanking.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**beneficiaries** | [**Array<SpidBeneficiaryResponse>**](SpidBeneficiaryResponse.md) |
|
|
6
|
+
**beneficiaries** | [**Array<SpidBeneficiaryResponse>**](SpidBeneficiaryResponse.md) | Es una lista de beneficiarios obtenidos. | [optional]
|
|
7
7
|
|
|
8
8
|
|
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**amount_limit** | **Float** | Monto límite permitido para la cuenta |
|
|
7
|
-
**bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta | [optional]
|
|
8
|
-
**beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE |
|
|
9
|
-
**email** | **Array<String>** | Lista de
|
|
6
|
+
**amount_limit** | **Float** | Monto límite permitido para la cuenta. Ejemplo: 1000.00 |
|
|
7
|
+
**bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta. | [optional]
|
|
8
|
+
**beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE. Ejemplo: 032180000118359719. |
|
|
9
|
+
**email** | **Array<String>** | Lista de correos electrónicos (emails), este dato es opcional. | [optional]
|
|
10
10
|
**institution** | [**BeneficiaryInstitution**](BeneficiaryInstitution.md) | Objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person |
|
|
11
|
-
**kind_of_relationship** | **String** |
|
|
12
|
-
**numeric_reference_spid** | **String** | Referencia numérica | [optional]
|
|
13
|
-
**payment_concept_spid** | **String** | Concepto de pago | [optional]
|
|
14
|
-
**register_date** | **DateTime** | La fecha en la que se registro el beneficiario | [optional]
|
|
15
|
-
**relationship** | **String** |
|
|
16
|
-
**rfc** | **String** | Registro federal de contribuyentes | [optional]
|
|
17
|
-
**status** | **String** | El estado en el que se encuentra el registo del beneficiario | [optional]
|
|
11
|
+
**kind_of_relationship** | **String** | Es el tipo de relación que se tiene con el propietario de la cuenta. Para registrar una cuenta, este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\"> relationships.</a> <br /><br /><b>Nota:</b> <em>Si en la respuesta de Monex esta propiedad es nula, tampoco estará presente en esta respuesta.</em> |
|
|
12
|
+
**numeric_reference_spid** | **String** | Referencia numérica. | [optional]
|
|
13
|
+
**payment_concept_spid** | **String** | Concepto de pago. | [optional]
|
|
14
|
+
**register_date** | **DateTime** | La fecha en la que se registro el beneficiario. | [optional]
|
|
15
|
+
**relationship** | **String** | Es la relación con el propietario de la cuenta, para registrar este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">relationships.</a> <br/> <br/> <b>Nota:</b> Si en la respuesta de Monex, sta propiedad es nula, tampoco estará presente en esta respuesta. |
|
|
16
|
+
**rfc** | **String** | Es el Registro federal de contribuyentes (RFC) de la persona o institución propietaria de la cuenta. <br/> <br/><b>Nota:</b> Se valida el formato de RFC. | [optional]
|
|
17
|
+
**status** | **String** | El estado en el que se encuentra el registo del beneficiario.<br><br> Los valores pueden ser: <b>\"RECEIVED\", \"DELETED\", \"REQUEST_ERROR_BY_MONEX\", \"REQUESTED_TO_MONEX\", \"NOTIFIED_BY_MONEX\", \"NOTIFIED_BY_SPEIOK\", \"NOTIFIED_WITH_ERROR_BY_SPEIOK\" y \"PENDING\"</b> | [optional]
|
|
18
18
|
|
|
19
19
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**classification_id** | **String** |
|
|
7
|
-
**description** | **String** |
|
|
6
|
+
**classification_id** | **String** | Es el identificador de la clasificación. | [optional]
|
|
7
|
+
**description** | **String** | Es la descripción de la clasificación de la operación. | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/SuscripcionesApi.md
CHANGED
|
@@ -4,17 +4,124 @@ 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
|
-
[**
|
|
8
|
-
[**
|
|
9
|
-
[**
|
|
7
|
+
[**change_subscription_status_using_put**](SuscripcionesApi.md#change_subscription_status_using_put) | **PUT** /subscriptions/{subscription}/status | Cambia el estatus de la suscripción
|
|
8
|
+
[**change_subscription_use_using_patch**](SuscripcionesApi.md#change_subscription_use_using_patch) | **PATCH** /subscriptions/{subscription} | Cambia el uso de la suscripción
|
|
9
|
+
[**pre_enrollment_monex_user_using_post**](SuscripcionesApi.md#pre_enrollment_monex_user_using_post) | **POST** /subscriptions/pre-subscription | Pre-registro de una suscripción
|
|
10
|
+
[**remove_enrollment_user_using_delete**](SuscripcionesApi.md#remove_enrollment_user_using_delete) | **DELETE** /subscriptions/{subscription} | Elimina suscripción por su identificador.
|
|
11
|
+
[**remove_subscription_pending_status_using_delete**](SuscripcionesApi.md#remove_subscription_pending_status_using_delete) | **DELETE** /subscriptions/pre-subscription/{subscription} | Elimina pre-registro de suscripción
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# **change_subscription_status_using_put**
|
|
15
|
+
> change_subscription_status_using_put(authorization, request, subscription)
|
|
16
|
+
|
|
17
|
+
Cambia el estatus de la suscripción
|
|
18
|
+
|
|
19
|
+
Se cambia el estado o estatus de la suscripción a los posibles valores que son: ACTIVE o INACTIVE
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'wire4_client'
|
|
25
|
+
|
|
26
|
+
api_instance = Wire4Client::SuscripcionesApi.new
|
|
27
|
+
|
|
28
|
+
authorization = 'authorization_example' # String | Header para token
|
|
29
|
+
|
|
30
|
+
request = Wire4Client::SubscriptionChangeStatusRequest.new # SubscriptionChangeStatusRequest | request
|
|
31
|
+
|
|
32
|
+
subscription = 'subscription_example' # String | subscription
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
#Cambia el estatus de la suscripción
|
|
37
|
+
api_instance.change_subscription_status_using_put(authorization, request, subscription)
|
|
38
|
+
rescue Wire4Client::ApiError => e
|
|
39
|
+
puts "Exception when calling SuscripcionesApi->change_subscription_status_using_put: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Parameters
|
|
44
|
+
|
|
45
|
+
Name | Type | Description | Notes
|
|
46
|
+
------------- | ------------- | ------------- | -------------
|
|
47
|
+
**authorization** | **String**| Header para token |
|
|
48
|
+
**request** | [**SubscriptionChangeStatusRequest**](SubscriptionChangeStatusRequest.md)| request |
|
|
49
|
+
**subscription** | **String**| subscription |
|
|
50
|
+
|
|
51
|
+
### Return type
|
|
52
|
+
|
|
53
|
+
nil (empty response body)
|
|
54
|
+
|
|
55
|
+
### Authorization
|
|
56
|
+
|
|
57
|
+
No authorization required
|
|
58
|
+
|
|
59
|
+
### HTTP request headers
|
|
60
|
+
|
|
61
|
+
- **Content-Type**: application/json
|
|
62
|
+
- **Accept**: */*
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
# **change_subscription_use_using_patch**
|
|
67
|
+
> ServiceBanking change_subscription_use_using_patch(authorization, request, subscription)
|
|
68
|
+
|
|
69
|
+
Cambia el uso de la suscripción
|
|
70
|
+
|
|
71
|
+
Se asigna o cambia el uso y el estatus que se le dará a la subscripción para los servicios SPEI y SPID en el manejo de Cobros y Pagos El status puede tener los posibles valores: ACTIVE o INACTIVE. El uso puede tener los posibles valores: WITHDRAWAL_DEPOSIT o WITHDRAWAL o DEPOSIT
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
```ruby
|
|
75
|
+
# load the gem
|
|
76
|
+
require 'wire4_client'
|
|
77
|
+
|
|
78
|
+
api_instance = Wire4Client::SuscripcionesApi.new
|
|
79
|
+
|
|
80
|
+
authorization = 'authorization_example' # String | Header para token
|
|
81
|
+
|
|
82
|
+
request = Wire4Client::ServiceBanking.new # ServiceBanking | request
|
|
83
|
+
|
|
84
|
+
subscription = 'subscription_example' # String | subscription
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
#Cambia el uso de la suscripción
|
|
89
|
+
result = api_instance.change_subscription_use_using_patch(authorization, request, subscription)
|
|
90
|
+
p result
|
|
91
|
+
rescue Wire4Client::ApiError => e
|
|
92
|
+
puts "Exception when calling SuscripcionesApi->change_subscription_use_using_patch: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**authorization** | **String**| Header para token |
|
|
101
|
+
**request** | [**ServiceBanking**](ServiceBanking.md)| request |
|
|
102
|
+
**subscription** | **String**| subscription |
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
[**ServiceBanking**](ServiceBanking.md)
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
No authorization required
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json
|
|
115
|
+
- **Accept**: */*
|
|
116
|
+
|
|
10
117
|
|
|
11
118
|
|
|
12
119
|
# **pre_enrollment_monex_user_using_post**
|
|
13
120
|
> PreEnrollmentResponse pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
|
|
14
121
|
|
|
15
|
-
|
|
122
|
+
Pre-registro de una suscripción
|
|
16
123
|
|
|
17
|
-
|
|
124
|
+
Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma. Se retorna una dirección URL hacia el centro de autorización donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/><br/>Una vez que el cuentahabiente autorice el acceso, se envía una notificación (webhook configurado) con el evento 'ENROLLMENT.CREATED', el cuál contiene los datos de acceso a esta API.
|
|
18
125
|
|
|
19
126
|
### Example
|
|
20
127
|
```ruby
|
|
@@ -29,7 +136,7 @@ pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | I
|
|
|
29
136
|
|
|
30
137
|
|
|
31
138
|
begin
|
|
32
|
-
#
|
|
139
|
+
#Pre-registro de una suscripción
|
|
33
140
|
result = api_instance.pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
|
|
34
141
|
p result
|
|
35
142
|
rescue Wire4Client::ApiError => e
|
|
@@ -62,9 +169,9 @@ No authorization required
|
|
|
62
169
|
# **remove_enrollment_user_using_delete**
|
|
63
170
|
> remove_enrollment_user_using_delete(authorization, subscription)
|
|
64
171
|
|
|
65
|
-
Elimina
|
|
172
|
+
Elimina suscripción por su identificador.
|
|
66
173
|
|
|
67
|
-
Elimina una suscripción
|
|
174
|
+
Elimina una suscripción mediante su identificador. Una vez eliminada dicha suscripción, ya no se podrán realizar operaciones en el API utilizando sus credenciales
|
|
68
175
|
|
|
69
176
|
### Example
|
|
70
177
|
```ruby
|
|
@@ -75,11 +182,11 @@ api_instance = Wire4Client::SuscripcionesApi.new
|
|
|
75
182
|
|
|
76
183
|
authorization = 'authorization_example' # String | Header para token
|
|
77
184
|
|
|
78
|
-
subscription = 'subscription_example' # String | El identificador de la suscripción a
|
|
185
|
+
subscription = 'subscription_example' # String | El identificador de la suscripción a ésta API
|
|
79
186
|
|
|
80
187
|
|
|
81
188
|
begin
|
|
82
|
-
#Elimina
|
|
189
|
+
#Elimina suscripción por su identificador.
|
|
83
190
|
api_instance.remove_enrollment_user_using_delete(authorization, subscription)
|
|
84
191
|
rescue Wire4Client::ApiError => e
|
|
85
192
|
puts "Exception when calling SuscripcionesApi->remove_enrollment_user_using_delete: #{e}"
|
|
@@ -91,7 +198,7 @@ end
|
|
|
91
198
|
Name | Type | Description | Notes
|
|
92
199
|
------------- | ------------- | ------------- | -------------
|
|
93
200
|
**authorization** | **String**| Header para token |
|
|
94
|
-
**subscription** | **String**| El identificador de la suscripción a
|
|
201
|
+
**subscription** | **String**| El identificador de la suscripción a ésta API |
|
|
95
202
|
|
|
96
203
|
### Return type
|
|
97
204
|
|
|
@@ -111,9 +218,9 @@ No authorization required
|
|
|
111
218
|
# **remove_subscription_pending_status_using_delete**
|
|
112
219
|
> remove_subscription_pending_status_using_delete(authorization, subscription)
|
|
113
220
|
|
|
114
|
-
Elimina
|
|
221
|
+
Elimina pre-registro de suscripción
|
|
115
222
|
|
|
116
|
-
Se elimina
|
|
223
|
+
Se elimina el pre-registro de suscripción. Sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la suscripcion esté pendiente.
|
|
117
224
|
|
|
118
225
|
### Example
|
|
119
226
|
```ruby
|
|
@@ -124,11 +231,11 @@ api_instance = Wire4Client::SuscripcionesApi.new
|
|
|
124
231
|
|
|
125
232
|
authorization = 'authorization_example' # String | Header para token
|
|
126
233
|
|
|
127
|
-
subscription = 'subscription_example' # String |
|
|
234
|
+
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
|
|
128
235
|
|
|
129
236
|
|
|
130
237
|
begin
|
|
131
|
-
#Elimina
|
|
238
|
+
#Elimina pre-registro de suscripción
|
|
132
239
|
api_instance.remove_subscription_pending_status_using_delete(authorization, subscription)
|
|
133
240
|
rescue Wire4Client::ApiError => e
|
|
134
241
|
puts "Exception when calling SuscripcionesApi->remove_subscription_pending_status_using_delete: #{e}"
|
|
@@ -140,7 +247,7 @@ end
|
|
|
140
247
|
Name | Type | Description | Notes
|
|
141
248
|
------------- | ------------- | ------------- | -------------
|
|
142
249
|
**authorization** | **String**| Header para token |
|
|
143
|
-
**subscription** | **String**|
|
|
250
|
+
**subscription** | **String**| Es el identificador de la suscripción a esta API. |
|
|
144
251
|
|
|
145
252
|
### Return type
|
|
146
253
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**request_id** | **String** |
|
|
7
|
-
**url** | **String** |
|
|
6
|
+
**request_id** | **String** | Es el identificador público generado para la petición (solicitud). | [optional]
|
|
7
|
+
**url** | **String** | Es la dirección URL generada para confirmación de la operación. Es para ingresar al centro de autorización. | [optional]
|
|
8
8
|
|
|
9
9
|
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Wire4Client::TransactionErrorCode
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**code** | **String** | | [optional]
|
|
7
|
+
**error** | **String** | | [optional]
|
|
8
|
+
**order_id** | **String** | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**amount** | **Float** |
|
|
7
|
-
**beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un
|
|
8
|
-
**cancel_return_url** | **String** |
|
|
9
|
-
**classification_id** | **String** |
|
|
10
|
-
**currency_code** | **String** | Código de moneda en la que opera la cuenta |
|
|
11
|
-
**email** | **Array<String>** | Lista de email del beneficiario
|
|
12
|
-
**numeric_reference_spid** | **Integer** |
|
|
13
|
-
**order_id** | **String** |
|
|
14
|
-
**payment_concept_spid** | **String** |
|
|
15
|
-
**return_url** | **String** |
|
|
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
|
+
**cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usario cancele el registro. |
|
|
9
|
+
**classification_id** | **String** | Es el identificador de la clasificación de la transferencia SPID. |
|
|
10
|
+
**currency_code** | **String** | Código de moneda en la que opera la cuenta. |
|
|
11
|
+
**email** | **Array<String>** | Lista de correo electrónico (email) del beneficiario. Este campo es opcional. | [optional]
|
|
12
|
+
**numeric_reference_spid** | **Integer** | Es la referencia numérica de la transferencia. |
|
|
13
|
+
**order_id** | **String** | Es la referencia de la transferencia asignada por el cliente. Ejemplo: dae9c6ae-8c7a-42e8-99f4-ebe90566efae |
|
|
14
|
+
**payment_concept_spid** | **String** | Es el concepto de la transferencia. |
|
|
15
|
+
**return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
|
|
16
16
|
|
|
17
17
|
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**cancel_return_url** | **String** |
|
|
7
|
-
**return_url** | **String** |
|
|
8
|
-
**transactions** | [**Array<TransactionOutgoing>**](TransactionOutgoing.md) | Lista de transferencias de salida que se enviarán a Monex |
|
|
6
|
+
**cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el usuario cancele. |
|
|
7
|
+
**return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de éxito. |
|
|
8
|
+
**transactions** | [**Array<TransactionOutgoing>**](TransactionOutgoing.md) | Lista de transferencias de salida que se enviarán a Monex. |
|
|
9
9
|
|
|
10
10
|
|