remittance-maker/README.md

Module that connects to remittance providers in order to quote and execute remittance orders

# remittance-maker  

This module connects to exchanges in order to quote and execute remittances.  

[![JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)  

## Installation  

npm install remittance-maker  

### Usage  

    var RemittanceMaker = require("remittance-maker").Maker  

    var maker = new RemittanceMaker({})  

### Primary functions  

#### quote Remittance Fixed Source  

Gives a quote for a remittance based on a fixed origin currency and amount  

    var options = {
      sourceCurrency: '',
      sourceAmount: ''
    }

    maker.quoteRemittanceFixedSource(options, function(err, res){

    })  


#### quote Remittance Fixed Destination  

Gives a quote for a remittance based on a fixed destination currency and amount  

    var options = {
      destinationCurrency: '',
      destinationAmount: ''
    }

    maker.quoteRemittanceFixedDestination(options, function(err, res){

    })  
    
#### executeRemittance  

Executes a remittance  

    var options = {
      sourceCurrency: '',
      sourceAmount: '',
      destinationCurrency: '',
      destinationAmunt: ''
    }

    maker.executeRemittance(options, function(err, res){

    })      

####      

# To Do  

Use nconf to handle configuration  



# Tips  

Uno vende Btc con reverse_quotation type Ask
Uno compra Btc con quotation type Bid  

Uno sabe cuantos btcAmount necesita para lograr un totalFiat con quotation type Ask
Uno sabe cuantos fiat necesita para lograr un btcAmount con reverse_quotation type Bid


# flujo