class Lithic::Resources::BookTransfers

def create(params)

Other tags:
    See: Lithic::Models::BookTransferCreateParams -

Returns:
  • (Lithic::Models::BookTransferResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • memo (String) --
  • token (String) --
  • type (Symbol, Lithic::Models::BookTransferCreateParams::Type) --
  • to_financial_account_token (String) --
  • subtype (String) --
  • from_financial_account_token (String) --
  • category (Symbol, Lithic::Models::BookTransferCreateParams::Category) --
  • amount (Integer) --

Overloads:
  • create(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, memo: nil, request_options: {}) 
def create(params)
  parsed, options = Lithic::Models::BookTransferCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/book_transfers",
    body: parsed,
    model: Lithic::Models::BookTransferResponse,
    options: options
  )
end

def initialize(client:)

Parameters:
  • client (Lithic::Client) --

Other tags:
    Api: - private 
def initialize(client:)
  @client = client
end

def list(params = {})

Other tags:
    See: Lithic::Models::BookTransferListParams -

Returns:
  • (Lithic::Internal::CursorPage) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • status (Symbol, Lithic::Models::BookTransferListParams::Status) --
  • starting_after (String) --
  • result (Symbol, Lithic::Models::BookTransferListParams::Result) --
  • page_size (Integer) --
  • financial_account_token (String) --
  • ending_before (String) --
  • end_ (Time) --
  • category (Symbol, Lithic::Models::BookTransferListParams::Category) --
  • business_account_token (String) --
  • begin_ (Time) --
  • account_token (String) --

Overloads:
  • list(account_token: nil, begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {}) 
def list(params = {})
  parsed, options = Lithic::Models::BookTransferListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/book_transfers",
    query: parsed,
    page: Lithic::Internal::CursorPage,
    model: Lithic::Models::BookTransferResponse,
    options: options
  )
end

def retrieve(book_transfer_token, params = {})

Other tags:
    See: Lithic::Models::BookTransferRetrieveParams -

Returns:
  • (Lithic::Models::BookTransferResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • book_transfer_token (String) --

Overloads:
  • retrieve(book_transfer_token, request_options: {}) 
def retrieve(book_transfer_token, params = {})
  @client.request(
    method: :get,
    path: ["v1/book_transfers/%1$s", book_transfer_token],
    model: Lithic::Models::BookTransferResponse,
    options: params[:request_options]
  )
end

def reverse(book_transfer_token, params = {})

Other tags:
    See: Lithic::Models::BookTransferReverseParams -

Returns:
  • (Lithic::Models::BookTransferResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • memo (String) --
  • book_transfer_token (String) --

Overloads:
  • reverse(book_transfer_token, memo: nil, request_options: {}) 
def reverse(book_transfer_token, params = {})
  parsed, options = Lithic::Models::BookTransferReverseParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/book_transfers/%1$s/reverse", book_transfer_token],
    body: parsed,
    model: Lithic::Models::BookTransferResponse,
    options: options
  )
end