estudiamas-spei-gateway

EstudiamasSpeiGateway - JavaScript client for estudiamas-spei-gateway Services to access to SPEI ecosystem This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit http://tcpip.tech

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install estudiamas-spei-gateway --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var EstudiamasSpeiGateway = require('estudiamas-spei-gateway');

var api = new EstudiamasSpeiGateway.ApplicationsApi()

var applicationToken = "applicationToken_example"; // {String} Application authentication token

var applicationCode = "applicationCode_example"; // {String} Application code

api.getApplicationBalance(applicationToken, applicationCode).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://sandbox.spei-gateway.tcpip.tech

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EstudiamasSpeiGateway.ApplicationsApi | getApplicationBalance | GET /api/1.0/applications/{applicationCode}/balance | Use this endpoint to get application's balance EstudiamasSpeiGateway.CepApi | downloadCepPDF | GET /api/1.0/applications/{applicationCode}/cep | Use this endpoint for get CEP in PDF format EstudiamasSpeiGateway.ClabesApi | activeCLABE | PUT /api/1.0/applications/{applicationCode}/customers/{customerCode}/clabes | Use this endpoint to activate CLABE account EstudiamasSpeiGateway.ClabesApi | asignClabeToCustomer | POST /api/1.0/applications/{applicationCode}/customers/{customerCode}/clabes | Use this endpoint to assign a new CLABE to given customer EstudiamasSpeiGateway.ClabesApi | inactiveCLABE | DELETE /api/1.0/applications/{applicationCode}/customers/{customerCode}/clabes | Use this endpoint to inactive CLABE account EstudiamasSpeiGateway.CustomersApi | getCustomerBalance | GET /api/1.0/applications/{applicationCode}/customers/{customerCode}/balance | Use this endpoint to get customer's balance EstudiamasSpeiGateway.CustomersApi | registerOrganizationCustomer | POST /api/1.0/applications/{applicationCode}/customers/organization | Use this endpoint register an organization as customer EstudiamasSpeiGateway.CustomersApi | registerPersonCustomer | POST /api/1.0/applications/{applicationCode}/customers/person | Use this endpoint register a person as customer EstudiamasSpeiGateway.SpeiApi | requestPayoutSpei | POST /api/1.0/applications/{applicationCode}/customers/{customerCode}/clabes/{clabe} | Use this endpoint request a new SPEI

Documentation for Models

• EstudiamasSpeiGateway.BalanceResponse
• EstudiamasSpeiGateway.ClabeResponse
• EstudiamasSpeiGateway.CustomerResponse
• EstudiamasSpeiGateway.DocumentationResponse
• EstudiamasSpeiGateway.ErrorResponse
• EstudiamasSpeiGateway.PayoutRequest
• EstudiamasSpeiGateway.PayoutResponse

Documentation for Authorization

All endpoints do not require authorization.