Transferwise
Welcome to transferwise ruby gem! The transferwise Ruby gem provide a small SDK for convenient access to the Transferwise API from applications written in the Ruby language. It provides a pre-defined set of classes for API resources that initialize themselves dynamically from API responses which allows the bindings to tolerate a number of different versions of the API.
Installation
Add this line to your application's Gemfile:
gem 'transferwise'And then execute:
$ bundle install
Or install it yourself as:
$ gem install transferwise
Usage
The library needs to be configured with environment mode "test" or "live"
For live mode
Transferwise.mode = "live"
For test mode
Transferwise.mode = "test"Development
Authentication
Transferwise uses OAuth 2 for API authentication and authorization. Calls done in behalf of the user require the access token, other calls require Basic Auth. Please keep in mind that tokens are unique to user and should be stored securely.
tw = Transferwise::OAuth.new(client_id, client_secret)redirect_url = "www.example.com/callback" # Url where you want user to redirect back after authentication from transferwise
url = tw.authorize_url(redirect_url)This will give you the url where you have to redirect the user to authorize and after authorization you will get redirected to redirect_url with authentication_code.
code = "aqw12q" # some authentication_code from response of authentication
tw.get_access_token(code, redirect_url)
=begin
Response:
{
"token_type" => "bearer",
"scope" => "transfers",
:access_token => "1bceb8d8-4115-4daa-8370-d9bc8de0c732",
:refresh_token => "6ff3451a-e713-416a-b735-20d8020f6ce2",
:expires_at => 1487908739
}
=endStore this access token and periodically refresh it before it expires
tw.refresh_token(access_token, opts = {refresh_token: refresh_token, expires_at: expires_at})
=begin
Response:
{
"token_type" => "bearer",
"scope" => "transfers",
:access_token => "59e18a25-c84e-4f06-aee4-416c9211a8c8",
:refresh_token => "6ff3451a-e713-416a-b735-20d8020f6ce2",
:expires_at => 1487873072
}
=endAnatomy of a Transferwise Transfer
To create the transfers, we need to get profile, quote and target account first.
Profile
Create a profile as individual or business.
profile_request = {
type: "personal", # or business
details: {
firstName: "First name", # Sender FirstName
lastName: "Last Name", # Sender LastName
dateOfBirth: "1980-07-20", # sender DOB
phoneNumber: "+918147001602" # Sender number in international format
}
}
profile = Transferwise::Profile.create(profile_request, {access_token: access_token})Quote
Create a quote
quote_request = {
profile: profile.id, # got from previous profile response
source: "USD", # source currency
target: "INR", # target currency
sourceAmount: "100", # source amount is amount which sender is going to send. Transferwise will deduct their fees and receipient will receive less money.
rateType: "FIXED",
type: 'BALANCE_PAYOUT' # or 'BALANCE_CONVERSION' if using for conversion
}
quote = Transferwise::Quote.create(quote_request, {access_token: access_token})Account
Next step is to create the account where you want to transfer the money. If you already have the account you can use that account id and skip this account creation part.
account_request = {
"profile" => profile.id,
"accountHolderName" => "Account Holder Name",
"currency" => "INR", # target currency name
"country" => "IN", # target country code
"type" => "", # get from account requirements
"details" => {
"legalType" => "PRIVATE",
"accountNumber" => "", # target account number
"ifscCode" => "", # ifsc code or any other field. Get field name finformation from account requirements api. This could be different for other country except india.
"address" => { # get address details also from account requirement based on country.
"city" => "City name", # city name
"country" => "IN", # country code
"firstLine" => "", # address first line
"postCode" => "" # post code
}
}
}
account = Transferwise::Account.create(account_request, {access_token: access_token})Transfer
Create a transfer
transfer_request = {
"customerTransactionId" => "d57db29d-1060-4ce8-bd5e-800edaf982a9", # some unique uuid format number to identify the transfer.
"targetAccount" => account.id,
"quote" => quote.id,
"details" => {
"reference" => "Any Comment" # get the field detail, from transfer requirements api before creating the transfer object.
}
}
transfer = Transferwise::Transfer.create(transfer_request, {access_token: access_token})The Transfer object is created via the Transferwise website. You can go there and make payments to complete the transfer.
Fund a transfer
Transferwise::Transfer.fund(transfer_id, { access_token: access_token })Cancel a transfer
Transferwise::Transfer.cancel(transfer_id, { access_token: access_token })Transferwise Borderless Account
A Borderless Account is a "virtual" bank account that you can control via the Transferwise API, to send funds to external bank accounts (across borders), as well as download statements and view the current balance.
Borderless Accounts
https://api-docs.transferwise.com/v1/borderless-account/search-account-by-user-profile
Get all the borderless accounts given a profileId
account_request = { profileId: 1234567 }
account = Transferwise::BorderlessAccount.list(nil, { 'params' => account_request, access_token: access_token })Borderless Account
https://api-docs.transferwise.com/v1/borderless-account/get-available-balances
Get a borderless account given a borderless_account_id
borderless_account_id = 123
account = Transferwise::BorderlessAccount.get(borderless_account_id, {access_token: access_token})Transactions
https://api-docs.transferwise.com/v1/borderless-account/get-account-statement
Get all the transactions for an account given a borderless_account_id
borderless_account_id = 123
transactions = Transferwise::BorderlessAccount::Transaction.list(nil, { 'params' => { page: '5' }, access_token: access_token }, borderless_account_id)Conversions
https://api-docs.transferwise.com/v1/borderless-account/convert-between-currencies
Move funds between your borderless account currencies.
borderless_account_id = 123
access_header = { access_token: access_token }
transactions = Transferwise::BorderlessAccount.convert(borderless_account_id, conversion_quote_id, access_header)Statement
https://api-docs.transferwise.com/v1/borderless-account/get-statement
Get a borderless account statement for a given currency
query_string = {
profileId: 1234567,
currency: 'GBP',
startDate: '2017-12-01',
endDate: '2017-12-07'
}
statement = Transferwise::BorderlessAccount::Statement.list(nil, { 'params' => query_string })Currencies
https://api-docs.transferwise.com/v1/borderless-account/available-currencies
Get a list of available currencies for your balances
Transferwise::BorderlessAccount::BalanceCurrency.list