class BridgeBankin::Transfer

Transfer resource

Constants

RESOURCE_TYPE

Public Class Methods

find(uuid:, access_token:, **params) click to toggle source

Retrieve a single transfer for the logged in user

@param [UUID] uuid the uuid of the requested resource @param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [Transfer] the requested transfer

# File lib/bridge_bankin/transfer.rb, line 52
def find(uuid:, access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/transfers/#{uuid}", **params)
    convert_to_bridge_object(**data)
  end
end
list(access_token:, **params) click to toggle source

List all logged in user transfers

@param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [Array<Transfer>] the user's transfers

# File lib/bridge_bankin/transfer.rb, line 36
def list(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/transfers", **params)
    convert_to_bridge_object(**data)
  end
end
list_all_receiver_accounts(access_token:, **params) click to toggle source

List all receiver transfer accounts

@param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [Array<BridgeObject>] the user accounts

# File lib/bridge_bankin/transfer.rb, line 82
def list_all_receiver_accounts(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/transfers/accounts/receivers", **params)
    convert_to_bridge_object(**data)
  end
end
list_all_sender_accounts(access_token:, **params) click to toggle source

List all sender transfer accounts

@param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [Array<BridgeObject>] the user accounts

# File lib/bridge_bankin/transfer.rb, line 67
def list_all_sender_accounts(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/transfers/accounts/senders", **params)
    convert_to_bridge_object(**data)
  end
end
list_receiver_accounts_for_sender(sender_account_id:, access_token:, **params) click to toggle source

List all receiver transfer accounts for a specific sender account

@param [Integer] sender_account_id the sender_account_id of the requested resource @param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [Array<BridgeObject>] the user accounts

# File lib/bridge_bankin/transfer.rb, line 98
def list_receiver_accounts_for_sender(sender_account_id:, access_token:, **params)
  protected_resource(access_token) do
    data = api_client.get("/v2/transfers/accounts/#{sender_account_id}/receivers", **params)
    convert_to_bridge_object(**data)
  end
end
send(access_token:, **params) click to toggle source

Request the URL to Bridge's Pay funnel to make a transfer

@param [String] access_token the access token provided during the user authentication @param [Hash] params any params that might be required (or optional) to communicate with the API

@return [BridgeObject] the URL to Bridge's Pay funnel

# File lib/bridge_bankin/transfer.rb, line 21
def send(access_token:, **params)
  protected_resource(access_token) do
    data = api_client.post("/v2/pay/transfer/url", **params)
    convert_to_bridge_object(**data)
  end
end