README

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:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/wire4/wire4-api-sdk-php.git"
    }
  ],
  "require": {
    "wire4/wire4-api-sdk-php": "dev-master"
  }
}

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

    require_once('/path/to/wire4-php-client/vendor/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.

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$accessToken= "";
try {
    // Create the authenticator to obtain access token
    $oauth = new \mx\wire4\auth\OAuthWire4 (
        'YOUR_OAUTH_CONSUMER_KEY', //REPLACE THIS WITH YOUR DATA
        'YOUR_OAUTH_CONSUMER_SECRET', //REPLACE THIS WITH YOUR DATA
        \mx\wire4\auth\Environment::SANDBOX); // O \mx\wire4\auth\Environment::PRODUCTION
    // Obtain an access token use application flow and scope "general"
    $accessToken= $oauth->obtainAccessTokenApp("general");
} catch(OAuthException $e) {
    echo "Respuesta: ". $e->lastResponse . "\n";
}

$apiInstance = new \mx\wire4\client\api\ComprobanteElectrnicoDePagoCEPApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = new \mx\wire4\client\model\CepSearchBanxico(); // \mx\wire4\client\model\CepSearchBanxico | Información para buscar un CEP

try {
    $result = $apiInstance->obtainTransactionCepUsingPOST($body,$accessToken);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ComprobanteElectrnicoDePagoCEPApi->obtainTransactionCepUsingPOST: ', $e->getMessage(), PHP_EOL;
}
?>

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.

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.

    $message = "{\"id\":\"evt_641296342fdbf2db40ce674dde4881b87ada81b1695ae1c54666578272c1cd10\",\"object\":\"spid_outgoing\",\"api_version\":\"1.0.0\",\"created\":\"2019-12-05T11:55:10.058-06:00\",\"data\":{\"account\":\"8999998\",\"amount\":120.25,\"currency_code\":\"USD\",\"monex_description\":\"Nombre Receptor: BANAMEX | Monto Pago: 120.25 | Cuenta beneficiaria: 112680000189999984 | Nombre Beneficiario: notificar@wire4.mx | Clave de Rastreo:  | Referencia Numerica: 1234567 | Concepto del pago: Transfer out test 1 | Fecha Confirmacion de Liquidacion: 05-12-2019 11:55:10\",\"detention_message\":\"Cuenta de beneficiario, no existe\",\"payment_order_id\":1427991983,\"status_code\":\"FAILED\",\"transaction_id\":704814938,\"beneficiary_account\":\"112680000189999984\",\"beneficiary_bank\":{\"key\":\"40112\",\"name\":\"BMONEX\",\"company_name\":\"BANCO MONEX S.A. INSTITUCION DE BANCA MULTIPLE, MONEX GRUPO FINANCIERO\",\"rfc\":\"BMI9704113PA\"},\"beneficiary_name\":\"notificar@wire4.mx\",\"concept\":\"Transfer out test 1\",\"order_id\":\"8A736A1D-ECA6-4959-93FE-794365F53E24\",\"reference\":1234567,\"request_id\":\"7dbf528d-b395-4779-924e-b182a4de17a5\",\"cep\":{}},\"livemode\":false,\"pending_webhooks\":0,\"request\":\"8A736A1D-ECA6-4959-93FE-794365F53E24\",\"type\":\"TRANSACTION.OUTGOING.SPID.RECEIVED\"}";
    $referenceString = "7c088d16a8a25f1640e95dfdce65770cb0a31dc0e71a9749bba1e4e114201efb6e78c50bea3d8d9337b8ea63b2a8abf5b1e03d0cf9dda6f8e83a509d1ac11908";
    $key = "wh_6b5cb70ab7fd489a8bd0c9d06513008"; //Lo encontraras en la consola de administracion de wire4.mx una vez que estes registrado y hayas dado de alta un webhook, reemplaza este valor

    $signResult = \mx\wire4\webhooks\sign\UtilsCompute::toExadecimal(
        \mx\wire4\webhooks\sign\UtilsCompute::computeHmacSha512($message, $key));

    var_dump($signResult);

    if( ! \mx\wire4\webhooks\sign\UtilsCompute::compareSignatures($referenceString,$signResult) ) {
        echo "Las firmas no son iguales:";

    } else {
        echo "Las validacion de firmas es correcta";
    }

    echo "\noriginal:".$referenceString;
    echo "\nresultado:".$signResult;

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