Download the PHP package wire4/wire4-api-sdk-php without Composer
On this page you can find all versions of the php package wire4/wire4-api-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wire4/wire4-api-sdk-php
More information about wire4/wire4-api-sdk-php
Files in wire4/wire4-api-sdk-php
Package wire4-api-sdk-php
Short Description Cliente sdk para trabajar con el api de wire4
Wire4 es una API - Fintech de Banco Monex con la que podrás administrar transferencias *SPEI
License proprietary
Homepage https://wire4.mx
Informations about the package wire4-api-sdk-php
wire4-php-client
Referencia de la API de Wire4
Cliente sdk para trabajar con el api de wire4
Wire4 es una API - Fintech de Banco Monex con la que podrás administrar transferencias SPEI
- Versión del API de Wire4: 1.0.0
- Versión del paquete SDK: 1.1.4
Requisitos
PHP 5.5 o posterior
Instalación y uso
Composer
Para instalar via Composer, agrega lo siguiente a composer.json
:
Ejecuta el siguiente comando:
composer install
o simplemente ejecuta desde la línea de comandos la siguiente línea:
composer require wire4/wire4-api-sdk-php dev-master
Una vez que se instalo el cliente en tu proyecto importa el autoload.php
Cómo iniciar
Por favor sigue el procedimiento de instalación (Instalacion y uso) y ejecuta el siguiente código de ejemplo reemplazando las credenciales de aplicación por tus datos. Toma en cuanta que estos son ejemplos que te servirán de referencia y que pueden cambiar pero debes crear una cuenta en wire4.mx para obtener tus datos de aplicación.
En el proyecto de github https://github.com/wire4/wire4-api-sdk-php encontrarás una sección de ejemplos (examples) que ilustra el uso del sdk en cada uno de los recursos disponibles en el api, sin embargo, para más detalle o la forma en como puedes utilizar cada uno de los métodos de la API te recomendamos revisar la documentación en la sección de "Referencia" en https://developers.wire4.mx
Documentación para los Endpoints de la API
Todos los URIs son relativos a https://sandbox-api.wire4.mx/wire4/1.0.0 en el ambiente de sandbox o https://api.wire4.mx/wire4/1.0.0 para el ambiente de producción.
Clase | Metodo | HTTP request | Descripción |
---|---|---|---|
AutorizacinDeDepsitosApi | getDepositAuthConfigurations | GET /subscriptions/{subscription}/configurations/deposit-authorization | Consulta autorización de depósitos |
AutorizacinDeDepsitosApi | putDepositAuthConfigurations | PUT /subscriptions/{subscription}/configurations/deposit-authorization | Habilita / Deshabilita la autorización de depósitos |
ComprobanteElectrnicoDePagoCEPApi | obtainTransactionCepUsingPOST | POST /ceps | Consulta de CEP |
ContactoApi | sendContactUsingPOST | POST /contact | Solicitud de contacto |
ContractsDetailsApi | createAuthorization | POST /onboarding/accounts/authorize | Devuelve la URL para autorización del usuario Monex |
ContractsDetailsApi | obtainAuthorizedUsers | GET /onboarding/accounts/{requestId}/authorized-users | Obtiene los usuarios autorizados |
ContractsDetailsApi | obtainAuthorizedUsersByContract | GET /onboarding/accounts/authorized-users | Obtiene los usuarios autorizados por contrato |
ContractsDetailsApi | obtainContractDetails | POST /onboarding/accounts/details | Obtiene los detalles de la empresa del contrato |
CuentasDeBeneficiariosSPEIApi | authorizeAccountsPendingPUT | PUT /subscriptions/{subscription}/beneficiaries/pending | Solicitud para agrupar cuentas de beneficiarios SPEI/SPID en estado pendiente. |
CuentasDeBeneficiariosSPEIApi | deleteAccountUsingDELETE | DELETE /subscriptions/{subscription}/beneficiaries/spei/{account} | Elimina la cuenta del beneficiario |
CuentasDeBeneficiariosSPEIApi | getAvailableRelationshipsMonexUsingGET | GET /subscriptions/{subscription}/beneficiaries/relationships | Consulta de relaciones |
CuentasDeBeneficiariosSPEIApi | getBeneficiariesByRequestId | GET /subscriptions/{subscription}/beneficiaries/spei/{requestId} | Consulta los beneficiarios por el identificador de la petición de registro |
CuentasDeBeneficiariosSPEIApi | getBeneficiariesForAccountUsingGET | GET /subscriptions/{subscription}/beneficiaries/spei | Consulta los beneficiarios registrados |
CuentasDeBeneficiariosSPEIApi | preRegisterAccountsUsingPOST | POST /subscriptions/{subscription}/beneficiaries/spei | Pre-registro de cuentas de beneficiarios SPEI®. |
CuentasDeBeneficiariosSPEIApi | removeBeneficiariesPendingUsingDELETE | DELETE /subscriptions/{subscription}/beneficiaries/spei/request/{requestId} | Eliminación de beneficiarios SPEI® sin confirmar |
CuentasDeBeneficiariosSPEIApi | updateAmountLimitAccountUsingPUT | PUT /subscriptions/{subscription}/beneficiaries/spei/{account} | Solicitud para actualizar el monto límite de una cuenta |
CuentasDeBeneficiariosSPIDApi | getSpidBeneficiariesForAccount | GET /subscriptions/{subscription}/beneficiaries/spid | Consulta los beneficiarios SPID registrados |
CuentasDeBeneficiariosSPIDApi | preRegisterAccountsUsingPOST1 | POST /subscriptions/{subscription}/beneficiaries/spid | Pre-registro de cuentas de beneficiarios SPID® |
DepositantesApi | getDepositantsUsingGET | GET /subscriptions/{subscription}/depositants | Consulta de cuentas de depositantes |
DepositantesApi | registerDepositantsUsingPOST | POST /subscriptions/{subscription}/depositants | Registra un nuevo depositante |
EmpresasCoDiApi | obtainCompanies | GET /codi/companies | Consulta de empresas CODI® |
EmpresasCoDiApi | registerCompanyUsingPOST | POST /codi/companies | Registro de empresas CODI® |
FacturasApi | billingsReportByIdUsingGET | GET /billings/{id} | Consulta de facturas por identificador |
FacturasApi | billingsReportUsingGET | GET /billings | Consulta de facturas |
InstitucionesApi | getAllInstitutionsUsingGET | GET /institutions | Consulta de instituciones bancarias |
LmitesDeMontosApi | obtainConfigurationsLimits | GET /subscriptions/{suscription}/configurations | Consulta de configuraciones |
LmitesDeMontosApi | updateConfigurations | PUT /subscriptions/{suscription}/configurations | Actualiza configuraciones por suscripción |
OperacionesCoDiApi | consultCodiOperations | POST /codi/charges | Consulta de operaciones |
PeticionesDePagoPorCoDiApi | consultCodiRequestByOrderId | GET /codi/sales-point/charges | Consulta información de petición por orderId |
PeticionesDePagoPorCoDiApi | generateCodiCodeQR | POST /codi/sales-point/charges | Genera código QR |
PuntosDeVentaCoDiApi | createSalesPoint | POST /codi/companies/salespoint | Registro de punto de venta. |
PuntosDeVentaCoDiApi | obtainSalePoints | GET /codi/companies/salespoint | Consulta de puntos de venta |
SaldoApi | getBalanceUsingGET | GET /subscriptions/{subscription}/balance | Consulta los saldo de una cuenta |
SuscripcionesApi | changeSubscriptionStatusUsingPUT | PUT /subscriptions/{subscription}/status | Cambia el estatus de la suscripción |
SuscripcionesApi | changeSubscriptionUseUsingPATCH | PATCH /subscriptions/{subscription} | Cambia el uso de la suscripción |
SuscripcionesApi | preEnrollmentMonexUserUsingPOST | POST /subscriptions/pre-subscription | Pre-registro de una suscripción |
SuscripcionesApi | removeEnrollmentUserUsingDELETE | DELETE /subscriptions/{subscription} | Elimina suscripción por su identificador. |
SuscripcionesApi | removeSubscriptionPendingStatusUsingDELETE | DELETE /subscriptions/pre-subscription/{subscription} | Elimina pre-registro de suscripción |
TransferenciasSPEIApi | createAuthorizationTransactionsGroup | POST /subscriptions/{subscription}/transactions/group | Agrupa transacciones bajo un request_id |
TransferenciasSPEIApi | dropTransactionsPendingUsingDELETE | DELETE /subscriptions/{subscription}/transactions/outcoming/spei/request/{requestId} | Eliminación de transferencias SPEI® pendientes |
TransferenciasSPEIApi | incomingSpeiTransactionsReportUsingGET | GET /subscriptions/{subscription}/transactions/incoming/spei | Consulta de transferencias recibidas |
TransferenciasSPEIApi | outCommingSpeiRequestIdTransactionsReportUsingGET | GET /subscriptions/{subscription}/transactions/outcoming/spei/{requestId} | Consulta de transferencias de salida por identificador de petición |
TransferenciasSPEIApi | outgoingSpeiTransactionsReportUsingGET | GET /subscriptions/{subscription}/transactions/outcoming/spei | Consulta de transferencias realizadas |
TransferenciasSPEIApi | registerOutgoingSpeiTransactionUsingPOST | POST /subscriptions/{subscription}/transactions/outcoming/spei | Registro de transferencias |
TransferenciasSPIDApi | getSpidClassificationsUsingGET | GET /subscriptions/{subscription}/beneficiaries/spid/classifications | Consulta de clasificaciones para operaciones SPID® |
TransferenciasSPIDApi | registerOutgoingSpidTransactionUsingPOST | POST /subscriptions/{subscription}/transactions/outcoming/spid | Registro de transferencias SPID® |
WebhooksApi | getWebhook | GET /webhooks/{id} | Consulta de Webhook |
WebhooksApi | getWebhooks | GET /webhooks | Consulta la lista de Webhooks |
WebhooksApi | registerWebhook | POST /webhooks | Alta de Webhook |
Documentación para los modelos
- Account
- AccountDetail
- AccountReassigned
- AccountRequest
- AccountResponse
- AccountSpid
- AddressCompany
- AmountRequest
- AuthorizationTransactionGroup
- AuthorizedBeneficiariesResponse
- AuthorizedUsers
- Balance
- BalanceListResponse
- BeneficiariesQueryRegisterStatus
- BeneficiariesResponse
- BeneficiaryInstitution
- Billing
- BillingTransaction
- CepResponse
- CepSearchBanxico
- CertificateRequest
- CodiCodeQrResponseDTO
- CodiCodeRequestDTO
- CodiOperationResponseDTO
- CodiOperationsFiltersRequestDTO
- CompanyRegistered
- CompanyRequested
- Compay
- ConfigurationsLimits
- ContactRequest
- ContractDetailRequest
- ContractDetailResponse
- Deposit
- DepositAuthorizationRequest
- Depositant
- DepositantsRegister
- DepositantsResponse
- DepositsAuthorizationResponse
- DetailedErrorResponse
- ErrorResponse
- GetDepositants
- Institution
- InstitutionsList
- Item
- MessageAccountBeneficiary
- MessageCEP
- MessageCodiAction
- MessageConfigurationsLimits
- MessageDepositAuthorizationRequest
- MessageDepositReceived
- MessageInstitution
- MessagePayment
- MessagePaymentStatePending
- MessageRequestChanged
- MessageSalesPoint
- MessageSubscription
- MessageUserAuthorized
- MessageWebHook
- Operations
- PagerResponseDto
- Payment
- PaymentCODI
- PaymentRequestCodiResponseDTO
- PaymentsRequestId
- Person
- PreEnrollmentData
- PreEnrollmentResponse
- PreMonexAuthorization
- Relationship
- RelationshipsResponse
- SalesPoint
- SalesPointFound
- SalesPointRequest
- SalesPointRespose
- ServiceBanking
- SpidBeneficiariesResponse
- SpidBeneficiaryResponse
- SpidClassificationDTO
- SpidClassificationsResponseDTO
- SubscriptionChangeStatusRequest
- TokenRequiredResponse
- TransactionErrorCode
- TransactionOutgoing
- TransactionOutgoingSpid
- TransactionsOutgoingRegister
- UpdateConfigurationsRequestDTO
- UrlsRedirect
- UseServiceBanking
- UserCompany
- WebHookDepositAuthorizationRequest
- WebHookDepositAuthorizationResponse
- Webhook
- WebhookRequest
- WebhookResponse
- WebhooksList
Validación de firma de webhooks
Te recomendamos revisar la documentación de Referencia de wire4 para mas detalle, no obstante te dejamos un ejemplo de validación de firmas para este cliente.
Documentación para la autenticación
wire4_aut_app
- Type: OAuth
- Flow: application
- Authorization URL Sandbox: https://sandbox-api.wire4.mx/token
- Authorization URL Producción: https://api.wire4.mx/token
- Scopes:
- ****
general
:
- ****
wire4_aut_app_user_spei
- Type: OAuth
- Flow: password
- Authorization URL Sandbox: https://sandbox-api.wire4.mx/token
- Authorization URL Producción: https://api.wire4.mx/token
- Scopes:
- **** spei_admin:
wire4_aut_app_user_spid
- Type: OAuth
- Flow: password
- Authorization URL Sandbox: https://sandbox-api.wire4.mx/token
- Authorization URL Producción: https://api.wire4.mx/token
- Scopes:
- **** spid_admin:
Author
Wire4 Todos los derechos reservados 2019. Politicas de privacidad - Términos y condiciones https://wire4.mx/#/policies/use-policies
All versions of wire4-api-sdk-php with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2