docs/TradesBankApi

CybridApiBank::TradesBankApi

All URIs are relative to https://bank.sandbox.cybrid.app

Method HTTP request Description
create_trade POST /api/trades Create Trade
get_trade GET /api/trades/{trade_guid} Get Trade
list_trades GET /api/trades Get trades list

create_trade

> create_trade(post_trade_bank_model)

Create Trade

Creates a trade. ## State | State | Description | |——-|————-| | storing | The Platform is storing the trade details in our private store | | pending | The Platform is executing the trade | | cancelled | The Platform has cancelled the trade | | settling | The Platform is settling the trade | | completed | The Platform has successfully completed the trade | | failed | The Platform was not able to successfully complete the trade | ## Failure codes | Code | Description | |——|————-| | non_sufficient_funds | The delivery account does not have enough funds to complete the trade | | unsupported | The trading pair is not supported for this customer | | limit_exceeded | The customer is over the limits that have been set for them for this activity | | expired_quote | The quote expired before it could be executed | | market_volatility | The quote could not be executed due to market volatility | Required scope: trades:execute

Examples

require 'time'
require 'cybrid_api_bank_ruby'
# setup authorization
CybridApiBank.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiBank::TradesBankApi.new
post_trade_bank_model = CybridApiBank::PostTradeBankModel.new({quote_guid: 'quote_guid_example'}) # PostTradeBankModel | 

begin
  # Create Trade
  result = api_instance.create_trade(post_trade_bank_model)
  p result
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->create_trade: #{e}"
end

Using the create_trade_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> , Integer, Hash)> create_trade_with_http_info(post_trade_bank_model)

begin
  # Create Trade
  data, status_code, headers = api_instance.create_trade_with_http_info(post_trade_bank_model)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->create_trade_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
post_trade_bank_model PostTradeBankModel

Return type

TradeBankModel

Authorization

BearerAuth, oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

get_trade

> get_trade(trade_guid)

Get Trade

Retrieves a trade. Required scope: trades:read

Examples

require 'time'
require 'cybrid_api_bank_ruby'
# setup authorization
CybridApiBank.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiBank::TradesBankApi.new
trade_guid = 'trade_guid_example' # String | Identifier for the trade.

begin
  # Get Trade
  result = api_instance.get_trade(trade_guid)
  p result
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->get_trade: #{e}"
end

Using the get_trade_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> , Integer, Hash)> get_trade_with_http_info(trade_guid)

begin
  # Get Trade
  data, status_code, headers = api_instance.get_trade_with_http_info(trade_guid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->get_trade_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
trade_guid String Identifier for the trade.

Return type

TradeBankModel

Authorization

BearerAuth, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_trades

> list_trades(opts)

Get trades list

Retrieves a listing of trades. Required scope: trades:read

Examples

require 'time'
require 'cybrid_api_bank_ruby'
# setup authorization
CybridApiBank.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiBank::TradesBankApi.new
opts = {
  page: 56, # Integer | The page index to retrieve.
  per_page: 56, # Integer | The number of entities per page to return.
  guid: 'guid_example', # String | Comma separated trade_guids to list trades for.
  bank_guid: 'bank_guid_example', # String | Comma separated bank_guids to list trades for.
  customer_guid: 'customer_guid_example', # String | Comma separated customer_guids to list trades for.
  account_guid: 'account_guid_example', # String | Comma separated account_guids to list trades for.
  state: 'state_example', # String | Comma separated states to list trades for.
  side: 'side_example', # String | Comma separated sides to list trades for.
  label: 'label_example', # String | Comma separated labels to list trades for.
  created_at_gte: 'created_at_gte_example', # String | Created at start date inclusive lower bound, ISO8601.
  created_at_lt: 'created_at_lt_example', # String | Created at end date exclusive upper bound, ISO8601.
  updated_at_gte: 'updated_at_gte_example', # String | Updated at start date inclusive lower bound, ISO8601.
  updated_at_lt: 'updated_at_lt_example' # String | Updated at end date exclusive upper bound, ISO8601.
}

begin
  # Get trades list
  result = api_instance.list_trades(opts)
  p result
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->list_trades: #{e}"
end

Using the list_trades_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> , Integer, Hash)> list_trades_with_http_info(opts)

begin
  # Get trades list
  data, status_code, headers = api_instance.list_trades_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => 
rescue CybridApiBank::ApiError => e
  puts "Error when calling TradesBankApi->list_trades_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
page Integer The page index to retrieve. [optional]
per_page Integer The number of entities per page to return. [optional]
guid String Comma separated trade_guids to list trades for. [optional]
bank_guid String Comma separated bank_guids to list trades for. [optional]
customer_guid String Comma separated customer_guids to list trades for. [optional]
account_guid String Comma separated account_guids to list trades for. [optional]
state String Comma separated states to list trades for. [optional]
side String Comma separated sides to list trades for. [optional]
label String Comma separated labels to list trades for. [optional]
created_at_gte String Created at start date inclusive lower bound, ISO8601. [optional]
created_at_lt String Created at end date exclusive upper bound, ISO8601. [optional]
updated_at_gte String Updated at start date inclusive lower bound, ISO8601. [optional]
updated_at_lt String Updated at end date exclusive upper bound, ISO8601. [optional]

Return type

TradeListBankModel

Authorization

BearerAuth, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json