Pagamentos

Contas a pagar: boletos de terceiros, Pix, DARF, tributos e concessionárias, os lotes, a aprovação, as contas de pagamento e o DDA.

Famílias nesta página

Família	Tools	read	write	destructive
Pagamentos (unificado)	6	2	0	4
Pagamento de boletos	4	2	0	2
Pagamento Pix	4	2	0	2
DARFs	4	2	0	2
Tributos	4	2	0	2
Concessionárias	4	2	0	2
Lotes de pagamento	5	2	0	3
Lotes de pagamento de boletos	1	0	0	1
Lotes de pagamento Pix	1	0	0	1
Lotes de DARF	1	0	0	1
Lotes de tributos	1	0	0	1
Lotes de concessionárias	1	0	0	1
Contas de pagamento	4	2	2	0
Contas DDA	6	2	1	3
Boletos DDA	5	2	0	3

Pagamentos (unificado)

Escopo: banking/payment.payments

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_payment_list	read	payment.payments.basic	GET /v2/payments	Lists the payments the account made or scheduled to third parties (contas a pagar) of every kind — Pix, bank billet, DARF, tax, utility, GRU — most recent first, with filters that combine.
banking_payment_payment_get	read	payment.payments.basic	GET /v2/payments/:uid	Returns every field of one payment of any kind (Pix, bank billet, DARF, tax, utility, GRU), including its status at the bank, in the same shape as the API v2.
banking_payment_payment_create	destructive	payment.payments.create	POST /v2/payments	Creates a payment from the account's money to a third party: a Pix QR code, a bank billet (boleto), a DARF, a tax or a utility bill.
banking_payment_payment_barcode	destructive	payment.payments.create	POST /v2/payments/barcode	Pays any document that has a barcode or digitable line — bank billet, utility bill or tax — detecting which from the code itself.
banking_payment_payment_cancel	destructive	payment.payments.destroy	PUT /v2/payments/:uid/cancel	Cancels a payment of any kind before the bank pays it.
banking_payment_payment_approve	destructive	payment.payment_batches.approve	PUT /v2/payments/:uid/approve	Releases (approves) a payment registered at the bank and waiting for approval, so the bank pays it.

Pagamento de boletos

Escopo: banking/payment.payments ou banking/payment.bank_billets

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_bank_billet_list	read	payment.payments.basic	GET /v2/payment/bank_billets	Lists the bank billets (boletos) the account paid or scheduled to pay, most recent first.
banking_payment_bank_billet_get	read	payment.payments.basic	GET /v2/payment/bank_billets/:uid	Returns every field of one bank billet payment, including the billet code, the beneficiary and the status at the bank, in the same shape as the API v2.
banking_payment_bank_billet_create	destructive	payment.payments.create	POST /v2/payment/bank_billets	Pays a bank billet (boleto) issued by a third party, from the account's money.
banking_payment_bank_billet_cancel	destructive	payment.payments.destroy	PUT /v2/payment/bank_billets/:uid/cancel	Cancels the payment of a bank billet before the bank pays it.

Pagamento Pix

Escopo: banking/payment.payments ou banking/payment.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_pix_list	read	payment.payments.basic	GET /v2/payment/pix	Lists the Pix QR codes the account paid or scheduled to pay, most recent first.
banking_payment_pix_get	read	payment.payments.basic	GET /v2/payment/pix/:uid	Returns every field of one Pix payment, including the QR code paid, the beneficiary and the status at the bank, in the same shape as the API v2.
banking_payment_pix_create	destructive	payment.payments.create	POST /v2/payment/pix	Pays a Pix QR code (copy-and-paste BR Code) from the account's money.
banking_payment_pix_cancel	destructive	payment.payments.destroy	PUT /v2/payment/pix/:uid/cancel	Cancels a Pix payment before the bank pays it, typically a scheduled one.

DARFs

Escopo: banking/payment.payments ou banking/payment.darfs

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_darf_list	read	payment.payments.basic	GET /v2/payment/darfs	Lists the DARFs (federal tax guides) the account paid or scheduled to pay, most recent first.
banking_payment_darf_get	read	payment.payments.basic	GET /v2/payment/darfs/:uid	Returns every field of one DARF payment, including the tax code, the taxpayer, the amounts and the status at the bank, in the same shape as the API v2.
banking_payment_darf_create	destructive	payment.payments.create	POST /v2/payment/darfs	Pays a DARF (federal tax guide) from its fields — tax code, calculation period, due date, taxpayer and amounts — not from a barcode (for a DARF with a barcode use banking_payment_payment_barcode).
banking_payment_darf_cancel	destructive	payment.payments.destroy	PUT /v2/payment/darfs/:uid/cancel	Cancels a DARF payment before the bank pays it, typically a scheduled one.

Tributos

Escopo: banking/payment.payments ou banking/payment.taxes

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_tax_list	read	payment.payments.basic	GET /v2/payment/taxes	Lists the tax guides (ITBI, ICMS, ISS, IPTU, DARE, GPS...) the account paid or scheduled to pay, most recent first.
banking_payment_tax_get	read	payment.payments.basic	GET /v2/payment/taxes/:uid	Returns every field of one tax payment, including its kind, its barcode or data and the status at the bank, in the same shape as the API v2.
banking_payment_tax_create	destructive	payment.payments.create	POST /v2/payment/taxes	Pays a tax guide (ITBI, ICMS, ISS, IPTU, FGTS, DARE, DARF, GRU, GPS) of the given kind, either from its barcode (format: code, the default, with code) or from its fields (format: data, with data).
banking_payment_tax_cancel	destructive	payment.payments.destroy	PUT /v2/payment/taxes/:uid/cancel	Cancels a tax payment before the bank pays it, typically a scheduled one.

Concessionárias

Escopo: banking/payment.payments ou banking/payment.utilities

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_utility_list	read	payment.payments.basic	GET /v2/payment/utilities	Lists the utility bills (concessionárias: water, power, phone...) the account paid or scheduled to pay, most recent first.
banking_payment_utility_get	read	payment.payments.basic	GET /v2/payment/utilities/:uid	Returns every field of one utility bill payment, including its barcode, the beneficiary and the status at the bank, in the same shape as the API v2.
banking_payment_utility_create	destructive	payment.payments.create	POST /v2/payment/utilities	Pays a utility bill (concessionária: water, power, gas, phone...) from its barcode or digitable line.
banking_payment_utility_cancel	destructive	payment.payments.destroy	PUT /v2/payment/utilities/:uid/cancel	Cancels a utility payment before the bank pays it, typically a scheduled one.

Lotes de pagamento

Escopo: banking/payment.payments ou banking/payment.batches

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_batch_list	read	payment.payment_batches.basic	GET /v2/payment/batches	Lists the payment batches (lotes de pagamento) of the account, of every payment kind, most recent first.
banking_payment_batch_get	read	payment.payment_batches.basic	GET /v2/payment/batches/:uid	Returns one payment batch with its status at the bank and every payment in it, in the same shape as the API v2.
banking_payment_batch_approve	destructive	payment.payment_batches.approve	PUT /v2/payment/batches/:uid/approve	Releases (approves) a payment batch registered at the bank and waiting for approval, so the bank pays every payment in it.
banking_payment_batch_reprove	destructive	payment.payment_batches.reprove	PUT /v2/payment/batches/:uid/reprove	Rejects (reproves) a payment batch waiting for approval at the bank, so none of its payments is made.
banking_payment_batch_cancel	destructive	payment.payment_batches.destroy	PUT /v2/payment/batches/:uid/cancel	Cancels a payment batch and the payments in it that the bank has not paid.

Lotes de pagamento de boletos

Escopo: banking/payment.payments ou banking/payment.bank_billets

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_bank_billet_batch_create	destructive	payment.payment_batches.create	POST /v2/payment/bank_billet_batches	Creates a batch that pays several bank billets (boletos) together, from new payments described here and/or existing bank billet payments of the account given by uid.

Lotes de pagamento Pix

Escopo: banking/payment.payments ou banking/payment.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_pix_batch_create	destructive	payment.payment_batches.create	POST /v2/payment/pix_batches	Creates a batch that pays several Pix QR codes together, from new payments described here and/or existing Pix payments of the account given by uid.

Lotes de DARF

Escopo: banking/payment.payments ou banking/payment.darfs

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_darf_batch_create	destructive	payment.payment_batches.create	POST /v2/payment/darf_batches	Creates a batch that pays several DARFs (federal tax guides) together, from new payments described by their fields here and/or existing DARF payments of the account given by uid.

Lotes de tributos

Escopo: banking/payment.payments ou banking/payment.taxes

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_tax_batch_create	destructive	payment.payment_batches.create	POST /v2/payment/tax_batches	Creates a batch that pays several tax guides together, from new payments described here (each with its kind and either format: code with code or format: data with data) and/or existing tax payments of the account given by uid.

Lotes de concessionárias

Escopo: banking/payment.payments ou banking/payment.utilities

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_utility_batch_create	destructive	payment.payment_batches.create	POST /v2/payment/utility_batches	Creates a batch that pays several utility bills (concessionárias) together, from new payments described here and/or existing utility payments of the account given by uid.

Contas de pagamento

Escopo: banking/payment.accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_payment_account_list	read	financial.payment_accounts.basic	GET /v2/payment/accounts	Lists the payment accounts of the account: the service accounts that link a financial account to the bank connection payments go through.
banking_payment_payment_account_get	read	financial.payment_accounts.basic	GET /v2/payment/accounts/:uid	Returns one payment account, in the same shape as the API v2.
banking_payment_payment_account_create	write	financial.payment_accounts.create	POST /v2/payment/accounts	Creates a payment account under a financial account of the account, so payments can be routed through it.
banking_payment_payment_account_update	write	financial.payment_accounts.update	PATCH /v2/payment/accounts/:uid	Changes a payment account: its agreement code, whether payments go by CNAB remittance, or its bank-specific data.

Contas DDA

Escopo: banking/payment.dda_accounts

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_dda_account_list	read	payment.dda.accounts.basic	GET /v2/payment/dda_accounts	Lists the DDA accounts of the account — the CNPJs registered to receive, through DDA, the bank billets issued against them — most recent first, with the status of the adhesion letter and of the approval.
banking_payment_dda_account_get	read	payment.dda.accounts.basic	GET /v2/payment/dda_accounts/:uid	Returns every field of one DDA account — CNPJ, signers, address, adhesion letter status and signed letter URL, approval status, enable/disable requests — in the same shape as the API v2.
banking_payment_dda_account_create	destructive	payment.dda.accounts.create	POST /v2/payment/dda_accounts	Registers a CNPJ for DDA (Débito Direto Autorizado), so the bank billets issued against it can be received by the account.
banking_payment_dda_account_update	destructive	payment.dda.accounts.update	PUT /v2/payment/dda_accounts/:uid	Changes the legal name, phone number, signers or address of a DDA account; only the fields given change, and signers replaces the whole list.
banking_payment_dda_account_enable	write	payment.dda.accounts.update	PUT /v2/payment/dda_accounts/:uid/enable	Asks the DDA provider to start receiving the bank billets issued against the account's CNPJ.
banking_payment_dda_account_disable	destructive	payment.dda.accounts.update	PUT /v2/payment/dda_accounts/:uid/disable	Asks the DDA provider to stop receiving the bank billets issued against the account's CNPJ and to remove the account's user there.

Boletos DDA

Escopo: banking/payment.dda.bank_billets

Tool	Tipo	Permissão	Espelha	O que faz
banking_payment_dda_bank_billet_list	read	payment.dda.bank_billets.basic	GET /v2/payment/dda_bank_billets	Lists the bank billets (boletos) the account received through DDA — issued by third parties against the CNPJ of one of its DDA accounts — most recent first, with Kobana's status (pending, released, rejected, paid) and the one at the bank (external_status).
banking_payment_dda_bank_billet_get	read	payment.dda.bank_billets.basic	GET /v2/payment/dda_bank_billets/:uid	Returns every field of one bank billet received through DDA — barcode, amounts, due date, fine, interest and discount, beneficiary, statuses and the payment made for it — in the same shape as the API v2.
banking_payment_dda_bank_billet_reject	destructive	payment.dda.bank_billets.update	PUT /v2/payment/dda_bank_billets/:uid/reject	Rejects a bank billet received through DDA, marking it in Kobana as not to be paid.
banking_payment_dda_bank_billet_release	destructive	payment.dda.bank_billets.update	PUT /v2/payment/dda_bank_billets/:uid/release	Releases (approves) a bank billet received through DDA for payment.
banking_payment_dda_bank_billet_delete	destructive	payment.dda.bank_billets.destroy	DELETE /v2/payment/dda_bank_billets/:uid	Deletes a bank billet received through DDA from the account, in any visible status (temporary billets are not found).

---

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.