Pix e Pix Automático

Cobranças Pix com QR Code, as contas Pix que as recebem e o Pix Automático: contas, recorrências, solicitações, cobranças e locations.

Famílias nesta página

Família	Tools	read	write	destructive
Cobranças Pix	8	4	2	2
Contas Pix	5	2	0	3
Pix Automático — contas	5	2	1	2
Pix Automático — recorrências	6	2	3	1
Pix Automático — solicitações	5	2	2	1
Pix Automático — cobranças	6	2	1	3
Pix Automático — locations	3	2	1	0

Cobranças Pix

Escopo: banking/charge.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_pix_list	read	charge.pix.basic	GET /v2/charge/pix	Lists Pix charges (cobranças Pix) the account issued, most recent first, with filters that combine.
banking_charge_pix_get	read	charge.pix.basic	GET /v2/charge/pix/:uid	Returns every field of one Pix charge, including its QR code, payer and payments, in the same shape as the API v2.
banking_charge_pix_create	write	charge.pix.create	POST /v2/charge/pix	Issues a Pix charge (cobrança Pix) with a QR code for the payer.
banking_charge_pix_update	write	charge.pix.update	PUT /v2/charge/pix/:uid/update	Changes an open Pix charge (amount, due date, payer, penalties, discounts).
banking_charge_pix_cancel	destructive	charge.pix.cancel	PUT /v2/charge/pix/:uid/cancel	Asks the Pix provider to cancel a charge, so it can no longer be paid.
banking_charge_pix_delete	destructive	charge.pix.destroy	DELETE /v2/charge/pix/:uid	Deletes a canceled Pix charge from the account.
banking_charge_pix_command_list	read	charge.pix.basic	GET /v2/charge/pix/:pix_uid/commands	Lists the update and cancel commands sent to the Pix provider for one charge, most recent first, with their status.
banking_charge_pix_command_get	read	charge.pix.basic	GET /v2/charge/pix/:pix_uid/commands/:uid	Returns one update or cancel command of a Pix charge, with its status at the provider.

Contas Pix

Escopo: banking/charge.pix_accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_pix_account_list	read	charge.pix_accounts.basic	GET /v2/charge/pix_accounts	Lists the Pix accounts of the account (the provider account and Pix key that receive Pix charges), most recent first, with their status.
banking_charge_pix_account_get	read	charge.pix_accounts.basic	GET /v2/charge/pix_accounts/:uid	Returns every field of one Pix account (provider, key, status, beneficiary, financial account), in the same shape as the API v2.
banking_charge_pix_account_create	destructive	charge.pix_accounts.create	POST /v2/charge/pix_accounts	Registers a Pix account: the provider account and Pix key that will receive the account's Pix charges.
banking_charge_pix_account_update	destructive	charge.pix_accounts.update	PATCH /v2/charge/pix_accounts/:uid	Changes a Pix account: name, enabled flag, default flag, Pix key or financial account.
banking_charge_pix_account_delete	destructive	charge.pix_accounts.destroy	DELETE /v2/charge/pix_accounts/:uid	Deletes a Pix account together with its Pix charges.

Pix Automático — contas

Escopo: banking/charge.automatic_pix.accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_automatic_pix_account_list	read	charge.automatic_pix.accounts.basic	GET /v2/charge/automatic_pix/accounts	Lists the Pix Automático receiving accounts of the account, most recent first, with their status (pending, inactive or active).
banking_charge_automatic_pix_account_get	read	charge.automatic_pix.accounts.basic	GET /v2/charge/automatic_pix/accounts/:uid	Returns every field of one Pix Automático receiving account (financial account, connection, provider, status), in the same shape as the API v2.
banking_charge_automatic_pix_account_create	write	charge.automatic_pix.accounts.create	POST /v2/charge/automatic_pix/accounts	Registers a Pix Automático receiving account on a financial account of the account.
banking_charge_automatic_pix_account_update	destructive	charge.automatic_pix.accounts.update	PATCH /v2/charge/automatic_pix/accounts/:uid	Changes a Pix Automático receiving account: name, external id, tags, custom data or the enabled flag.
banking_charge_automatic_pix_account_delete	destructive	charge.automatic_pix.accounts.destroy	DELETE /v2/charge/automatic_pix/accounts/:uid	Deletes a Pix Automático receiving account.

Pix Automático — recorrências

Escopo: banking/charge.automatic_pix.recurrences

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_automatic_pix_recurrence_list	read	charge.pix.basic	GET /v2/charge/automatic_pix/recurrences	Lists the Pix Automático recurrences (payer authorizations for recurring debits) of the account, most recent first, with their provider status.
banking_charge_automatic_pix_recurrence_get	read	charge.pix.basic	GET /v2/charge/automatic_pix/recurrences/:uid	Returns every field of one Pix Automático recurrence (debtor, terms, provider status, QR code, requests, cancellation or rejection), in the same shape as the API v2.
banking_charge_automatic_pix_recurrence_create	write	charge.pix.create	POST /v2/charge/automatic_pix/recurrences	Creates a Pix Automático recurrence: the terms (cycle, amount, dates, retry policy) under which a debtor will authorize recurring Pix debits to a Pix Automático account.
banking_charge_automatic_pix_recurrence_update	write	charge.pix.update	PATCH /v2/charge/automatic_pix/recurrences/:uid	Changes the Kobana-side data of a recurrence (external id, tags, custom data).
banking_charge_automatic_pix_recurrence_command_update	write	charge.pix.update	PUT /v2/charge/automatic_pix/recurrences/:uid/update	Changes a registered recurrence at the provider: its charge Pix, location, start date or debtor name.
banking_charge_automatic_pix_recurrence_command_cancel	destructive	charge.pix.cancel	PUT /v2/charge/automatic_pix/recurrences/:uid/cancel	Asks the provider to cancel a registered recurrence, so no further Pix Automático charges can be debited under it.

Pix Automático — solicitações

Escopo: banking/charge.automatic_pix.requests

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_automatic_pix_request_list	read	charge.pix.basic	GET /v2/charge/automatic_pix/requests	Lists the Pix Automático authorization requests of the account (sent to the debtor's bank for a recurrence), most recent first, with their provider status.
banking_charge_automatic_pix_request_get	read	charge.pix.basic	GET /v2/charge/automatic_pix/requests/:uid	Returns every field of one Pix Automático authorization request (debtor account, provider status, rejection or cancellation), in the same shape as the API v2.
banking_charge_automatic_pix_request_create	write	charge.pix.create	POST /v2/charge/automatic_pix/recurrences/:recurrence_uid/requests	Creates an authorization request for a registered recurrence, addressed to the debtor's bank account: the debtor approves or rejects the recurring debits in their bank's app.
banking_charge_automatic_pix_request_update	write	charge.pix.update	PATCH /v2/charge/automatic_pix/requests/:uid	Changes the Kobana-side data of an authorization request (external id, tags, custom data).
banking_charge_automatic_pix_request_command_cancel	destructive	charge.pix.cancel	PUT /v2/charge/automatic_pix/requests/:uid/cancel	Asks the provider to cancel an authorization request, so the debtor can no longer approve it.

Pix Automático — cobranças

Escopo: banking/charge.automatic_pix.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_automatic_pix_pix_list	read	charge.pix.basic	GET /v2/charge/automatic_pix/pix	Lists the Pix Automático charges (scheduled debits under authorized recurrences) of the account, most recent first, with their provider status.
banking_charge_automatic_pix_pix_get	read	charge.pix.basic	GET /v2/charge/automatic_pix/pix/:uid	Returns every field of one Pix Automático charge (amount, date, provider status, retries, received payments, cancellation or rejection), in the same shape as the API v2.
banking_charge_automatic_pix_pix_create	destructive	charge.pix.create	POST /v2/charge/automatic_pix/recurrences/:recurrence_uid/pix	Schedules a Pix Automático charge: a debit from the debtor's account on expire_at, under a recurrence the debtor already authorized.
banking_charge_automatic_pix_pix_update	write	charge.pix.update	PATCH /v2/charge/automatic_pix/pix/:uid	Changes the Kobana-side data of a Pix Automático charge (external id, tags, custom data).
banking_charge_automatic_pix_pix_command_cancel	destructive	charge.pix.cancel	PUT /v2/charge/automatic_pix/pix/:uid/cancel	Asks the provider to cancel a scheduled Pix Automático charge, so the debtor is not debited.
banking_charge_automatic_pix_pix_command_retry	destructive	charge.pix.update	PUT /v2/charge/automatic_pix/pix/:uid/retry	Schedules a new debit attempt of a Pix Automático charge that is active, expired or rejected at the provider, on a future date.

Pix Automático — locations

Escopo: banking/charge.automatic_pix.locations

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_automatic_pix_location_list	read	charge.pix.basic	GET /v2/charge/automatic_pix/locations	Lists the Pix Automático locations of the account (the provider URLs a recurrence QR code points to), most recent first.
banking_charge_automatic_pix_location_get	read	charge.pix.basic	GET /v2/charge/automatic_pix/locations/:uid	Returns every field of one Pix Automático location, including the provider URL once it is registered, in the same shape as the API v2.
banking_charge_automatic_pix_location_create	write	charge.pix.create	POST /v2/charge/automatic_pix/locations	Creates a Pix Automático location on a Pix Automático account.

---

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.