treezor_client

TreezorClient - the Ruby gem for the Treezor

Treezor API. more info here.

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.1.1

  • Package version: 1.0.0

  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build treezor_client.gemspec

Then either install the gem locally:

gem install ./treezor_client-1.0.0.gem

(for development, run gem install --dev ./treezor_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'treezor_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'treezor_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'treezor_client'

# Setup authorization
TreezorClient.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = TreezorClient::BalanceApi.new

opts = { 
  access_signature: "access_signature_example", # String | Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](https://agent.treezor.com/security-authentication).
  access_tag: "access_tag_example", # String | Access tag is used for idem potency query. More info [here](https://agent.treezor.com/basics).
  access_user_id: 56, # Integer | Access user's id is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
  access_user_ip: "access_user_ip_example", # String | Access user's ip is used for user's action restriction. More info [here](https://agent.treezor.com/basics).
  wallet_id: 56, # Integer | Wallet's ID of wanted balance
  user_id: 56 # Integer | Wallet's user id of wanted balanced
}

begin
  #search balances
  result = api_instance.get_balances(opts)
  p result
rescue TreezorClient::ApiError => e
  puts "Exception when calling BalanceApi->get_balances: #{e}"
end

Documentation for API Endpoints

All URIs are relative to sandbox.treezor.com/v1/index.php

Class | Method | HTTP request | Description ———— | ————- | ————- | ————- TreezorClient::BalanceApi | get_balances | GET /balances | search balances TreezorClient::BankaccountApi | delete_bankaccount | DELETE /bankaccounts/id} | deactivate a bank account TreezorClient::BankaccountApi | | GET /bankaccounts/id | get a bank account TreezorClient::BankaccountApi | | GET /bankaccounts | search bank accounts TreezorClient::BankaccountApi | post_bankaccount | POST /bankaccounts | create a bank account TreezorClient::BeneficiariesApi | get_beneficiaries | GET /beneficiaries | search beneficiary bank accounts TreezorClient::BeneficiariesApi | get_beneficiary | GET /beneficiaries/id | get a beneficiary bank account TreezorClient::BeneficiariesApi | | POST /beneficiaries | create a beneficiary TreezorClient::BeneficiariesApi | put_beneficiary | PUT /beneficiaries/id | edit a beneficiary TreezorClient::BusinessApi | | GET /businessinformations | get business information TreezorClient::BusinessApi | businesssearchs_get | GET /businesssearchs | search businesses TreezorClient::CardApi | cardimages_get | GET /cardimages | get a card image TreezorClient::CardApi | cards_create_virtual_post | POST /cards/CreateVirtual | create a virtual card TreezorClient::CardApi | cards_get | GET /cards | search cards TreezorClient::CardApi | cards_id_activate_put | PUT /cards/id/Activate/ | activate a card TreezorClient::CardApi | | PUT /cards/id/ChangePIN/ | change card’s PIN TreezorClient::CardApi | | PUT /cards/id/ConvertVirtual/ | convert card to virtual TreezorClient::CardApi | | DELETE /cards/id | deactivate a card TreezorClient::CardApi | | GET /cards/id | get a card TreezorClient::CardApi | | PUT /cards/id/Limits/ | update card’s limits TreezorClient::CardApi | | PUT /cards/id/LockUnlock/ | update card’s blocking status TreezorClient::CardApi | | PUT /cards/id/Options/ | update card’s options TreezorClient::CardApi | | PUT /cards/id | update card informations TreezorClient::CardApi | | PUT /cards/id/Regenerate/ | regenerate card TreezorClient::CardApi | | PUT /cards/id/setPIN/ | set card’s PIN TreezorClient::CardApi | | PUT /cards/id/UnblockPIN/ | unblock card’s PIN TreezorClient::CardApi | | POST /cards/RequestPhysical | create a physical card TreezorClient::CardDigitalizationsApi | card_digitalizations_id | GET /cardDigitalizations/id | Get a card digitalizations based on its internal id TreezorClient::CardDigitalizationsApi | | PUT /cardDigitalizations/id | Update the status of a payment Token TreezorClient::CardDigitalizationsApi | | GET /cardDigitalizations | search for card digitalizations TreezorClient::CardReserveApi | card_reserve_add_to | POST /cardReserves/AddTo | add an amount to the reserved amount of a card TreezorClient::CardReserveApi | card_reserve_check | POST /cardReserves/Check | check reserved amount TreezorClient::CardReserveApi | card_reserve_get | GET /cardReserves/id | get the reserved amount of a card TreezorClient::CardtransactionApi | | GET /cardtransactions/id | get a card transaction TreezorClient::CardtransactionApi | | GET /cardtransactions | search for card transactions TreezorClient::CountryRestrictionGroupsApi | delete_country_restriction_groups | DELETE /countryRestrictionGroups/id | cancel a country group TreezorClient::CountryRestrictionGroupsApi | | GET /countryRestrictionGroups | search country restriction groups TreezorClient::CountryRestrictionGroupsApi | get_country_restriction_groups_id | GET /countryRestrictionGroups/id | get a country group TreezorClient::CountryRestrictionGroupsApi | | POST /countryRestrictionGroups | create a countryRestrictionGroup TreezorClient::CountryRestrictionGroupsApi | put_country_restriction_groups | PUT /countryRestrictionGroups/id | edit a country restriction group TreezorClient::DocumentApi | | POST /documents | create a document TreezorClient::DocumentApi | delete_document | DELETE /documents/id | delete document TreezorClient::DocumentApi | | GET /documents/id | get a document TreezorClient::DocumentApi | | GET /documents | search documents TreezorClient::DocumentApi | put_document | PUT /documents/id | update a document TreezorClient::HeartbeatApi | | GET /heartbeats | Get the status of the API TreezorClient::IssuerInitiatedDigitizationDataApi | tav_request_post | POST /issuerInitiatedDigitizationDatas | Request the issuerInitiatedDigitizationData TreezorClient::IssuerInitiatedDigitizationDataApi | tavrequestget | GET /issuerInitiatedDigitizationDatas | Search issuerInitiatedDigitizationData requests TreezorClient::MandateApi | delete_mandate | DELETE /mandates/id | revoke a mandate TreezorClient::MandateApi | | GET /mandates/id | get mandate TreezorClient::MandateApi | | GET /mandates | search mandates TreezorClient::MandateApi | mandates_id_resend_otp_put | PUT /mandates/id/ResendOtp/ | send an OTP TreezorClient::MandateApi | | PUT /mandates/id/Sign/ | sign a mandate TreezorClient::MandateApi | | POST /mandates | create a mandate TreezorClient::MccRestrictionGroupsApi | delete_mcc_restriction_groups | DELETE /mccRestrictionGroups/id | cancel a mcc group TreezorClient::MccRestrictionGroupsApi | | GET /mccRestrictionGroups | search mcc restriction groups TreezorClient::MccRestrictionGroupsApi | get_mcc_restriction_groups_id | GET /mccRestrictionGroups/id | get a mcc group TreezorClient::MccRestrictionGroupsApi | | POST /mccRestrictionGroups | create a mccRestrictionGroup TreezorClient::MccRestrictionGroupsApi | put_mcc_restriction_groups | PUT /mccRestrictionGroups/id | edit a mcc restriction group TreezorClient::MerchantIdRestrictionGroupsApi | | DELETE /merchantIdRestrictionGroups/id | cancel a merchant id restriction group TreezorClient::MerchantIdRestrictionGroupsApi | | GET /merchantIdRestrictionGroups | search merchant id restriction groups TreezorClient::MerchantIdRestrictionGroupsApi | get_merchant_id_restriction_groups_id | GET /merchantIdRestrictionGroups/id | get a merchant ID restriction group TreezorClient::MerchantIdRestrictionGroupsApi | | POST /merchantIdRestrictionGroups | create a merchantIdRestrictionGroup TreezorClient::MerchantIdRestrictionGroupsApi | put_merchant_id_restriction_groups | PUT /merchantIdRestrictionGroups/id | edit a merchant id restriction group TreezorClient::PayinApi | | DELETE /payins/id | delete a pay in TreezorClient::PayinApi | | GET /payins/id | get a pay in TreezorClient::PayinApi | | GET /payins | search pay ins TreezorClient::PayinApi | post_payin | POST /payins | create a pay in TreezorClient::PayinrefundApi | delete_payinrefund | DELETE /payinrefunds/id | cancel a pay in refund TreezorClient::PayinrefundApi | | GET /payinrefunds/id | get a pay in refund TreezorClient::PayinrefundApi | | GET /payinrefunds | search pay in refunds TreezorClient::PayinrefundApi | post_payinrefunds | POST /payinrefunds | create a pay in refund TreezorClient::PayoutApi | delete_payout | DELETE /payouts/id | cancel a payout TreezorClient::PayoutApi | | GET /payouts/id | get a payout TreezorClient::PayoutApi | | GET /payouts | search pay outs TreezorClient::PayoutApi | post_payout | POST /payouts | create a pay out TreezorClient::TransactionApi | get_transaction | GET /transactions/id | get a transaction TreezorClient::TransactionApi | | GET /transactions | search transactions TreezorClient::TransferApi | delete_transfer | DELETE /transfers/id | cancel a transfer TreezorClient::TransferApi | | GET /transfers/id | get a transfer TreezorClient::TransferApi | | GET /transfers | search transfers TreezorClient::TransferApi | post_transfers | POST /transfers | create a transfer TreezorClient::TransferrefundApi | delete_transferrefund | DELETE /transferrefunds/id | cancel a transfer refund TreezorClient::TransferrefundApi | | GET /transferrefunds/id | get a transfer refund TreezorClient::TransferrefundApi | | GET /transferrefunds | search transfer refunds TreezorClient::TransferrefundApi | post_transferrefunds | POST /transferrefunds | create a transfer refund TreezorClient::UserApi | delete_user | DELETE /users/id | delete a user TreezorClient::UserApi | | GET /users/id | get an user TreezorClient::UserApi | | GET /users | search users TreezorClient::UserApi | put_user | PUT /users/id | update a user TreezorClient::UserApi | | POST /users | create user TreezorClient::UserApi | users_id_kycreview_put | PUT /users/id/Kycreview/ | review user information TreezorClient::VirtualibansApi | | GET /virtualibans/id | get a virtualiban by Id TreezorClient::VirtualibansApi | | GET /virtualibans | search virtualibans TreezorClient::VirtualibansApi | post_virtual_iban | POST /virtualibans | create a virtual IBAN TreezorClient::VirtualibansApi | put_virtual_iban | PUT /virtualibans/id | update a Virtual IBAN TreezorClient::WalletApi | | DELETE /wallets/id | delete a wallet TreezorClient::WalletApi | | GET /wallets/id | get a wallet TreezorClient::WalletApi | | GET /wallets | search wallets TreezorClient::WalletApi | post_wallets | POST /wallets | create a wallet TreezorClient::WalletApi | put_wallet | PUT /wallets/{id | update a wallet

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key

  • API key parameter name: Authorization

  • Location: HTTP header