class StarkBank::DictKey
# DictKey
object
DictKey
represents a PIX key registered in Bacen's DICT system.
## Parameters (required):
-
id [string]:
DictKey
object unique id and PIX key itself. ex: 'tony@starkbank.com', '722.461.430-04', '20.018.183/0001-80', '+5511988887777', 'b6295ee1-f054-47d1-9e90-ee57b74f60d9'
## Attributes (return-only):
-
type [string, default nil]: DICT key type. ex: 'email', 'cpf', 'cnpj', 'phone' or 'evp'
-
name [string, default nil]: account owner full name. ex: 'Tony Stark'
-
tax_id
[string, default nil]: key owner tax ID (CNPJ or masked CPF). ex: '*.345.678-' or '20.018.183/0001-80' -
owner_type
[string, default nil]: DICT key owner type. ex 'naturalPerson' or 'legalPerson' -
bank_name
[string, default nil]: bank name associated with the DICT key. ex: 'Stark Bank' -
ispb [string, default nil]: bank ISPB associated with the DICT key. ex: '20018183'
-
branch_code
[string, default nil]: bank account branch code associated with the DICT key. ex: '9585' -
account_number
[string, default nil]: bank account number associated with the DICT key. ex: '9828282578010513' -
account_type
[string, default nil]: bank account type associated with the DICT key. ex: 'checking', 'saving', 'salary' or 'payment' -
status [string, default nil]: current DICT key status. ex: 'created', 'registered', 'canceled' or 'failed'
-
account_created
[DateTime or string, default nil]: creation datetime of the bank account associated with the DICT key. ex: '2020-11-05T14:55:08.812665+00:00' -
owned [DateTime or string, default nil]: datetime since when the current owner hold this DICT key. ex : '2020-11-05T14:55:08.812665+00:00'
-
created [DateTime or string, default nil]: creation datetime for the DICT key. ex: '2020-03-10 10:30:00.000'
Attributes
Public Class Methods
# Retrieve a specific DictKey
Receive a single DictKey
object by passing its id
## Parameters (required):
-
id [string]:
DictKey
object unique id and PIX key itself. ex: 'tony@starkbank.com', '722.461.430-04', '20.018.183/0001-80', '+5511988887777', 'b6295ee1-f054-47d1-9e90-ee57b74f60d9'
## Parameters (optional):
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
DictKey
object with updated attributes
# File lib/dict_key/dict_key.rb, line 63 def self.get(id, user: nil) StarkBank::Utils::Rest.get_id(id: id, user: user, **resource) end
StarkBank::Utils::Resource::new
# File lib/dict_key/dict_key.rb, line 31 def initialize( id:, type:, name:, tax_id:, owner_type:, bank_name:, ispb:, branch_code:, account_number:, account_type:, status:, account_created:, owned:, created: ) super(id) @type = type @name = name @tax_id = tax_id @owner_type = owner_type @bank_name = bank_name @ispb = ispb @branch_code = branch_code @account_number = account_number @account_type = account_type @status = status @account_created = StarkBank::Utils::Checks.check_datetime(account_created) @owned = StarkBank::Utils::Checks.check_datetime(owned) @created = StarkBank::Utils::Checks.check_datetime(created) end
# Retrieve paged DictKeys
Receive a list of up to 100 DictKey
objects previously created in the Stark Bank API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.
## Parameters (optional):
-
cursor [string, default nil]: cursor returned on the previous page function call
-
limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-
type [string, default nil]:
DictKey
type. ex: 'cpf', 'cnpj', 'phone', 'email' or 'evp' -
after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-
before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-
ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-
status [string, default nil]: filter for status of retrieved objects. ex: 'canceled', 'registered'
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
list of
DictKey
objects with updated attributes and cursor to retrieve the next page ofDictKey
objects
# File lib/dict_key/dict_key.rb, line 114 def self.page(cursor: nil, limit: nil, type: nil, after: nil, before: nil, ids: nil, status: nil, user: nil) after = StarkBank::Utils::Checks.check_date(after) before = StarkBank::Utils::Checks.check_date(before) return StarkBank::Utils::Rest.get_page( cursor: cursor, limit: limit, type: type, after: after, before: before, ids: ids, status: status, user: user, **resource ) end
# Retrieve DitcKeys
Receive a generator of DitcKey objects previously created in the Stark Bank API
## Parameters (optional):
-
limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-
type [string, default nil]:
DictKey
type. ex: 'cpf', 'cnpj', 'phone', 'email' or 'evp' -
after [Date, DateTime, Time or string, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-
before [Date, DateTime, Time or string, default nil]: date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
-
ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
-
status [string, default nil]: filter for status of retrieved objects. ex: 'canceled', 'registered'
-
user [Organization/Project object]:
Organization
orProject
object. Not necessary ifStarkBank.user
was set before function call
## Return:
-
generator of DitcKey objects with updated attributes
# File lib/dict_key/dict_key.rb, line 82 def self.query(limit: nil, type: nil, after: nil, before: nil, ids: nil, status: nil, user: nil) after = StarkBank::Utils::Checks.check_date(after) before = StarkBank::Utils::Checks.check_date(before) StarkBank::Utils::Rest.get_stream( limit: limit, type: type, after: after, before: before, ids: ids, status: status, user: user, **resource ) end
# File lib/dict_key/dict_key.rb, line 130 def self.resource { resource_name: 'DictKey', resource_maker: proc { |json| DictKey.new( id: json['id'], account_type: json['account_type'], name: json['name'], tax_id: json['tax_id'], owner_type: json['owner_type'], bank_name: json['bank_name'], ispb: json['ispb'], branch_code: json['branch_code'], account_number: json['account_number'], type: json['type'], status: json['status'], account_created: json['account_created'], owned: json['owned'], created: json['created'] ) } } end