wire4_client
Wire4Client - the Ruby gem for the Wire4RestAPI
Referencia de la API de Wire4
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.11
- Build package: io.swagger.codegen.languages.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build wire4_client.gemspec
Then either install the gem locally:
gem install ./wire4_client-1.0.11.gem
(for development, run gem install --dev ./wire4_client-1.0.11.gem to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'wire4_client', '~> 1.0.11'
Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
gem 'wire4_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'wire4_client'
api_instance = Wire4Client::AutorizacinDeDepsitosApi.new
= 'authorization_example' # String | Header para token
subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
begin
#Consulta autorización de depósitos
result = api_instance.get_deposit_auth_configurations(, subscription)
p result
rescue Wire4Client::ApiError => e
puts "Exception when calling AutorizacinDeDepsitosApi->get_deposit_auth_configurations: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://sandbox-api.wire4.mx/wire4/1.0.0
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Wire4Client::AutorizacinDeDepsitosApi | get_deposit_auth_configurations | GET /subscriptions/subscription/configurations/deposit-authorization | Consulta autorización de depósitos |
| Wire4Client::AutorizacinDeDepsitosApi | put_deposit_auth_configurations | PUT /subscriptions/subscription/configurations/deposit-authorization | Habilita / Deshabilita la autorización de depósitos |
| Wire4Client::ComprobanteElectrnicoDePagoCEPApi | obtain_transaction_cep_using_post | POST /ceps | Consulta de CEP |
| Wire4Client::ContactoApi | send_contact_using_post | POST /contact | Solicitud de contacto |
| Wire4Client::ContractsDetailsApi | create_authorization | POST /onboarding/accounts/authorize | Devuelve la URL para autorización del usuario Monex |
| Wire4Client::ContractsDetailsApi | obtain_authorized_users | GET /onboarding/accounts/requestId/authorized-users | Obtiene los usuarios autorizados |
| Wire4Client::ContractsDetailsApi | obtain_authorized_users_by_contract | GET /onboarding/accounts/authorized-users | Obtiene los usuarios autorizados por contrato |
| Wire4Client::ContractsDetailsApi | obtain_contract_details | POST /onboarding/accounts/details | Obtiene los detalles de la empresa del contrato |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | authorize_accounts_pending_put | PUT /subscriptions/subscription/beneficiaries/pending | Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente. |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | delete_account_using_delete | DELETE /subscriptions/subscription/beneficiaries/spei/account | Elimina la cuenta del beneficiario |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | get_available_relationships_monex_using_get | GET /subscriptions/subscription/beneficiaries/relationships | Consulta de relaciones |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | get_beneficiaries_by_request_id | GET /subscriptions/subscription/beneficiaries/spei/requestId | Consulta los beneficiarios por el identificador de la petición de registro |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | get_beneficiaries_for_account_using_get | GET /subscriptions/subscription/beneficiaries/spei | Consulta los beneficiarios registrados |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | pre_register_accounts_using_post | POST /subscriptions/subscription/beneficiaries/spei | Pre-registro de cuentas de beneficiarios SPEI®. |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | remove_beneficiaries_pending_using_delete | DELETE /subscriptions/subscription/beneficiaries/spei/request/requestId | Eliminación de beneficiarios SPEI® sin confirmar |
| Wire4Client::CuentasDeBeneficiariosSPEIApi | update_amount_limit_account_using_put | PUT /subscriptions/subscription/beneficiaries/spei/account | Solicitud para actualizar el monto límite de una cuenta |
| Wire4Client::CuentasDeBeneficiariosSPIDApi | get_spid_beneficiaries_for_account | GET /subscriptions/subscription/beneficiaries/spid | Consulta los beneficiarios SPID registrados |
| Wire4Client::CuentasDeBeneficiariosSPIDApi | pre_register_accounts_using_post1 | POST /subscriptions/subscription/beneficiaries/spid | Pre-registro de cuentas de beneficiarios SPID® |
| Wire4Client::DepositantesApi | get_depositants_using_get | GET /subscriptions/subscription/depositants | Consulta de cuentas de depositantes |
| Wire4Client::DepositantesApi | register_depositants_using_post | POST /subscriptions/subscription/depositants | Registra un nuevo depositante |
| Wire4Client::EmpresasCoDiApi | obtain_companies | GET /codi/companies | Consulta de empresas CODI® |
| Wire4Client::EmpresasCoDiApi | register_company_using_post | POST /codi/companies | Registro de empresas CODI® |
| Wire4Client::FacturasApi | billings_report_by_id_using_get | GET /billings/id | Consulta de facturas por identificador |
| Wire4Client::FacturasApi | billings_report_using_get | GET /billings | Consulta de facturas |
| Wire4Client::InstitucionesApi | get_all_institutions_using_get | GET /institutions | Consulta de instituciones bancarias |
| Wire4Client::LmitesDeMontosApi | obtain_configurations_limits | GET /subscriptions/suscription/configurations | Consulta de configuraciones |
| Wire4Client::LmitesDeMontosApi | update_configurations | PUT /subscriptions/suscription/configurations | Actualiza configuraciones por suscripción |
| Wire4Client::OperacionesCoDiApi | consult_codi_operations | POST /codi/charges | Consulta de operaciones |
| Wire4Client::PeticionesDePagoPorCoDiApi | consult_codi_request_by_order_id | GET /codi/sales-point/charges | Consulta información de petición por orderId |
| Wire4Client::PeticionesDePagoPorCoDiApi | generate_codi_code_qr | POST /codi/sales-point/charges | Genera código QR |
| Wire4Client::PuntosDeVentaCoDiApi | create_sales_point | POST /codi/companies/salespoint | Registro de punto de venta. |
| Wire4Client::PuntosDeVentaCoDiApi | obtain_sale_points | GET /codi/companies/salespoint | Consulta de puntos de venta |
| Wire4Client::SaldoApi | get_balance_using_get | GET /subscriptions/subscription/balance | Consulta los saldo de una cuenta |
| Wire4Client::SuscripcionesApi | change_subscription_status_using_put | PUT /subscriptions/subscription/status | Cambia el estatus de la suscripción |
| Wire4Client::SuscripcionesApi | change_subscription_use_using_patch | PATCH /subscriptions/subscription | Cambia el uso de la suscripción |
| Wire4Client::SuscripcionesApi | pre_enrollment_monex_user_using_post | POST /subscriptions/pre-subscription | Pre-registro de una suscripción |
| Wire4Client::SuscripcionesApi | remove_enrollment_user_using_delete | DELETE /subscriptions/subscription | Elimina suscripción por su identificador. |
| Wire4Client::SuscripcionesApi | remove_subscription_pending_status_using_delete | DELETE /subscriptions/pre-subscription/subscription | Elimina pre-registro de suscripción |
| Wire4Client::TransferenciasSPEIApi | create_authorization_transactions_group | POST /subscriptions/subscription/transactions/group | Agrupa transacciones bajo un request_id |
| Wire4Client::TransferenciasSPEIApi | drop_transactions_pending_using_delete | DELETE /subscriptions/subscription/transactions/outcoming/spei/request/requestId | Eliminación de transferencias SPEI® pendientes |
| Wire4Client::TransferenciasSPEIApi | incoming_spei_transactions_report_using_get | GET /subscriptions/subscription/transactions/incoming/spei | Consulta de transferencias recibidas |
| Wire4Client::TransferenciasSPEIApi | 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 |
| Wire4Client::TransferenciasSPEIApi | outgoing_spei_transactions_report_using_get | GET /subscriptions/subscription/transactions/outcoming/spei | Consulta de transferencias realizadas |
| Wire4Client::TransferenciasSPEIApi | register_outgoing_spei_transaction_using_post | POST /subscriptions/subscription/transactions/outcoming/spei | Registro de transferencias |
| Wire4Client::TransferenciasSPIDApi | get_spid_classifications_using_get | GET /subscriptions/subscription/beneficiaries/spid/classifications | Consulta de clasificaciones para operaciones SPID® |
| Wire4Client::TransferenciasSPIDApi | register_outgoing_spid_transaction_using_post | POST /subscriptions/subscription/transactions/outcoming/spid | Registro de transferencias SPID® |
| Wire4Client::WebhooksApi | get_webhook | GET /webhooks/webhook_id | Consulta de Webhook |
| Wire4Client::WebhooksApi | get_webhooks | GET /webhooks | Consulta la lista de Webhooks |
| Wire4Client::WebhooksApi | register_webhook | POST /webhooks | Alta de Webhook |
Documentation for Models
- Wire4Client::Account
- Wire4Client::AccountDetail
- Wire4Client::AccountReassigned
- Wire4Client::AccountRequest
- Wire4Client::AccountResponse
- Wire4Client::AccountSpid
- Wire4Client::AddressCompany
- Wire4Client::AmountRequest
- Wire4Client::AuthorizationTransactionGroup
- Wire4Client::AuthorizedBeneficiariesResponse
- Wire4Client::AuthorizedUsers
- Wire4Client::Balance
- Wire4Client::BalanceListResponse
- Wire4Client::BeneficiariesQueryRegisterStatus
- Wire4Client::BeneficiariesResponse
- Wire4Client::BeneficiaryInstitution
- Wire4Client::Billing
- Wire4Client::BillingTransaction
- Wire4Client::CepResponse
- Wire4Client::CepSearchBanxico
- Wire4Client::CertificateRequest
- Wire4Client::CodiCodeQrResponseDTO
- Wire4Client::CodiCodeRequestDTO
- Wire4Client::CodiOperationResponseDTO
- Wire4Client::CodiOperationsFiltersRequestDTO
- Wire4Client::CompanyRegistered
- Wire4Client::CompanyRequested
- Wire4Client::Compay
- Wire4Client::ConfigurationsLimits
- Wire4Client::ContactRequest
- Wire4Client::ContractDetailRequest
- Wire4Client::ContractDetailResponse
- Wire4Client::Deposit
- Wire4Client::DepositAuthorizationRequest
- Wire4Client::Depositant
- Wire4Client::DepositantsRegister
- Wire4Client::DepositantsResponse
- Wire4Client::DepositsAuthorizationResponse
- Wire4Client::DetailedErrorResponse
- Wire4Client::ErrorResponse
- Wire4Client::GetDepositants
- Wire4Client::Institution
- Wire4Client::InstitutionsList
- Wire4Client::Item
- Wire4Client::MessageAccountBeneficiary
- Wire4Client::MessageCEP
- Wire4Client::MessageCodiAction
- Wire4Client::MessageConfigurationsLimits
- Wire4Client::MessageDepositAuthorizationRequest
- Wire4Client::MessageDepositReceived
- Wire4Client::MessageInstitution
- Wire4Client::MessagePayment
- Wire4Client::MessagePaymentStatePending
- Wire4Client::MessageRequestChanged
- Wire4Client::MessageSalesPoint
- Wire4Client::MessageSubscription
- Wire4Client::MessageUserAuthorized
- Wire4Client::MessageWebHook
- Wire4Client::Operations
- Wire4Client::PagerResponseDto
- Wire4Client::Payment
- Wire4Client::PaymentCODI
- Wire4Client::PaymentRequestCodiResponseDTO
- Wire4Client::PaymentsRequestId
- Wire4Client::Person
- Wire4Client::PreEnrollmentData
- Wire4Client::PreEnrollmentResponse
- Wire4Client::PreMonexAuthorization
- Wire4Client::Relationship
- Wire4Client::RelationshipsResponse
- Wire4Client::SalesPoint
- Wire4Client::SalesPointFound
- Wire4Client::SalesPointRequest
- Wire4Client::SalesPointRespose
- Wire4Client::ServiceBanking
- Wire4Client::SpidBeneficiariesResponse
- Wire4Client::SpidBeneficiaryResponse
- Wire4Client::SpidClassificationDTO
- Wire4Client::SpidClassificationsResponseDTO
- Wire4Client::SubscriptionChangeStatusRequest
- Wire4Client::TokenRequiredResponse
- Wire4Client::TransactionErrorCode
- Wire4Client::TransactionOutgoing
- Wire4Client::TransactionOutgoingSpid
- Wire4Client::TransactionsOutgoingRegister
- Wire4Client::UpdateConfigurationsRequestDTO
- Wire4Client::UrlsRedirect
- Wire4Client::UseServiceBanking
- Wire4Client::UserCompany
- Wire4Client::WebHookDepositAuthorizationRequest
- Wire4Client::WebHookDepositAuthorizationResponse
- Wire4Client::Webhook
- Wire4Client::WebhookRequest
- Wire4Client::WebhookResponse
- Wire4Client::WebhooksList
Documentation for Authorization
All endpoints do not require authorization.