Clientes, eventos e consultas

Clientes e pessoas, o histórico de eventos, webhooks e e-mails, as contas de e-mail, as importações e as consultas de boleto e de QR Code Pix.

Famílias nesta página

Família	Tools	read	write	destructive
Clientes	5	2	2	1
Pessoas	4	2	1	1
Eventos	2	2	0	0
Webhooks	5	2	0	3
Histórico de e-mails	2	2	0	0
Contas de e-mail	6	2	1	3
Importações	2	2	0	0
Consultas de boleto	3	2	1	0
Consultas de QR Code Pix	3	2	1	0

Clientes

Escopo: banking/crm.customers

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_customer_list	read	crm.customers.basic	GET /v2/data/customers	Lists the customers (payers) registered on the account, most recent first, with filters that combine.
banking_data_customer_get	read	crm.customers.basic	GET /v2/data/customers/:uid	Returns every field of one customer, in the same shape as the API v2.
banking_data_customer_create	write	crm.customers.create	POST /v2/data/customers	Registers a customer (payer) on the account, to be used on charges.
banking_data_customer_update	write	crm.customers.update	PUT /v2/data/customers/:uid	Changes the fields given of one customer; fields left out keep their value.
banking_data_customer_delete	destructive	crm.customers.destroy	DELETE /v2/data/customers/:uid	Deletes a customer from the account.

Pessoas

Escopo: banking/crm.people

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_person_list	read	crm.people.basic	GET /v2/data/people	Lists the people (individuals and companies) registered on the account, most recent first, with filters that combine.
banking_data_person_get	read	crm.people.basic	GET /v2/data/people/:uid	Returns every field of one person, with addresses, phones and e-mails, in the same shape as the API v2.
banking_data_person_create	write	crm.people.create	POST /v2/data/people	Registers a person (individual or company) on the account.
banking_data_person_delete	destructive	crm.people.destroy	DELETE /v2/data/people/:uid	Deletes a person from the account.

Eventos

Escopo: banking/system.events

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_event_list	read	system.events.basic	GET /v2/data/events	Lists the events the account generated (e.g. bank_billet.paid), latest first.
banking_data_event_get	read	system.events.basic	GET /v2/data/events/:uid	Returns one event of the account with its payload (data), in the same shape as the API v2.

Webhooks

Escopo: banking/automation.webhooks

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_webhook_list	read	automation.webhooks.basic	GET /v2/data/webhooks	Lists the webhooks of the account (endpoints that receive its events), most recent first, with filters that combine.
banking_data_webhook_get	read	automation.webhooks.basic	GET /v2/data/webhooks/:uid	Returns one webhook of the account, in the same shape as the API v2.
banking_data_webhook_create	destructive	automation.webhooks.create	POST /v2/data/webhooks	Registers a webhook: from now on the account's events of the chosen codes, with the data of its billets, payers and payments, are sent to url, and a ping event is sent right away.
banking_data_webhook_update	destructive	automation.webhooks.update	PUT /v2/data/webhooks/:uid	Changes the fields given of one webhook (URL, events, content type, active…); fields left out keep their value.
banking_data_webhook_delete	destructive	automation.webhooks.destroy	DELETE /v2/data/webhooks/:uid	Deletes a webhook: its endpoint stops receiving the account events.

Histórico de e-mails

Escopo: banking/automation.email_deliveries

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_email_delivery_list	read	automation.email_deliveries.basic	GET /v2/data/email_deliveries	Lists the notification e-mails the account sent (to payers, about billets and other events), most recent first, with their delivery status.
banking_data_email_delivery_get	read	automation.email_deliveries.basic	GET /v2/data/email_deliveries/:uid	Returns one notification e-mail the account sent, with its recipients, subject and delivery, read and click tracking, in the same shape as the API v2.

Contas de e-mail

Escopo: banking/automation.email_accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_automation_email_account_list	read	automation.email_accounts.basic	GET /v2/automation/email/email_accounts	Lists the Kobana-hosted e-mail accounts (sender domains) the account sends notifications from, most recent first, with their domain verification status.
banking_automation_email_account_get	read	automation.email_accounts.basic	GET /v2/automation/email/email_accounts/:uid	Returns one hosted e-mail account, with the DNS records the domain must publish and their verification status, in the same shape as the API v2.
banking_automation_email_account_create	destructive	automation.email_accounts.create	POST /v2/automation/email/email_accounts	Creates a Kobana-hosted e-mail account for a corporate domain, from which the account's notifications are sent.
banking_automation_email_account_update	destructive	automation.email_accounts.update	PUT /v2/automation/email/email_accounts/:uid	Changes the fields given of one hosted e-mail account (sender, reply-to, enabled…); fields left out keep their value.
banking_automation_email_account_delete	destructive	automation.email_accounts.destroy	DELETE /v2/automation/email/email_accounts/:uid	Deletes a hosted e-mail account: notifications stop being sent from its domain.
banking_automation_email_account_check_identity	write	automation.email_accounts.update	PUT /v2/automation/email/email_accounts/:uid/check_identity	Asks the e-mail provider whether the DNS records of the account's domain are published, and stores the answer: dns.dns_status becomes validated when they are, awaiting while they are not yet visible, and error or failure when the provider rejects them or cannot be reached.

Importações

Escopo: banking/system.imports

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_import_list	read	system.imports.basic	GET /v2/data/imports/:collection_name	Lists the spreadsheet imports of one collection (customers, bank billets…), most recent first, with their processing status and row counts.
banking_data_import_get	read	system.imports.basic	GET /v2/data/imports/:collection_name/:uid	Returns one spreadsheet import, with its status, row counts and row errors, in the same shape as the API v2.

Consultas de boleto

Escopo: banking/data.bank_billet_queries

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_bank_billet_query_list	read	data.bank_billet_queries.basic	GET /v2/data/bank_billet_queries	Lists the bank billet queries the account made (lookups of a boleto by its digitable line or barcode), most recent first, with filters that combine.
banking_data_bank_billet_query_get	read	data.bank_billet_queries.basic	GET /v2/data/bank_billet_queries/:uid	Returns one bank billet query with what the lookup found (amounts, due date, beneficiary, payer, whether it can be paid), in the same shape as the API v2.
banking_data_bank_billet_query_create	write	data.bank_billet_queries.create	POST /v2/data/bank_billet_queries	Looks up a boleto at the query provider by its digitable line or barcode and stores the result: amounts, due date, beneficiary, payer and whether it can still be paid (valid_for_payment).

Consultas de QR Code Pix

Escopo: banking/data.pix_qrcode_queries

Tool	Tipo	Permissão	Espelha	O que faz
banking_data_pix_qrcode_query_list	read	data.pix_qrcode_queries.basic	GET /v2/data/pix_qrcode_queries	Lists the Pix QR code queries the account made, most recent first, with filters that combine.
banking_data_pix_qrcode_query_get	read	data.pix_qrcode_queries.basic	GET /v2/data/pix_qrcode_queries/:public_id	Returns one Pix QR code query with what the provider decoded (Pix key, amounts, due date, beneficiary, debtor, whether it can be paid), in the same shape as the API v2.
banking_data_pix_qrcode_query_create	write	data.pix_qrcode_queries.create	POST /v2/data/pix_qrcode_queries	Decodes a Pix QR code (copia e cola) at the Pix provider and stores the result: Pix key, amounts, due date, beneficiary, debtor and whether it can be paid (can_be_paid, cannot_be_paid_reason).

---

Os campos de cada recurso estão na Referência da API. Uma tool que você não pode rodar não aparece em tools/list; se uma daqui não está lá, veja Autenticação.