Transferências

TED, Pix e transferência interna, avulsas ou em lote, a aprovação e as contas de transferência.

Famílias nesta página

Família	Tools	read	write	destructive
Transferências (unificado)	6	2	0	4
TED	6	2	0	4
Transferência Pix	6	2	0	4
Transferência interna	6	2	0	4
Lotes de transferência	5	2	0	3
Lotes de TED	1	0	0	1
Lotes de transferência Pix	1	0	0	1
Lotes de transferência interna	1	0	0	1
Contas de transferência	4	2	1	1

Transferências (unificado)

Escopo: banking/transfer.transfers

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_transfer_list	read	payment.transfers.basic	GET /v2/transfers	Lists the transfers the account sent or scheduled — TED, Pix and internal — newest first.
banking_transfer_transfer_get	read	payment.transfers.basic	GET /v2/transfers/:uid	Returns every field of one transfer of any kind (TED, Pix, internal), including its destination and its status at the bank, in the same shape as the API v2.
banking_transfer_transfer_create	destructive	payment.transfers.create	POST /v2/transfers	Sends money from the account to a third party by TED, Pix or internal transfer.
banking_transfer_transfer_cancel	destructive	payment.transfers.destroy	PUT /v2/transfers/:uid/cancel	Cancels a transfer of any kind before the bank sends it, typically a scheduled one.
banking_transfer_transfer_approve	destructive	payment.transfer_batches.approve	PUT /v2/transfers/:uid/approve	Releases (approves) a transfer registered at the bank and waiting for approval, so the bank sends it.
banking_transfer_transfer_reschedule	destructive	payment.transfers.update	PUT /v2/transfers/:uid/reschedule	Moves a scheduled transfer of any kind to another date.

TED

Escopo: banking/transfer.transfers ou banking/transfer.ted

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_ted_list	read	payment.transfers.basic	GET /v2/transfer/ted	Lists the TED transfers the account sent or scheduled, newest first.
banking_transfer_ted_get	read	payment.transfers.basic	GET /v2/transfer/ted/:uid	Returns every field of one TED transfer, including its destination and its status at the bank, in the same shape as the API v2.
banking_transfer_ted_create	destructive	payment.transfers.create	POST /v2/transfer/ted	Sends money from the account by TED to a bank account (bank_account) or to a judicial deposit (judicial_deposit_number and judicial_deposit_bank_code, only from banks that support it, without bank_account).
banking_transfer_ted_cancel	destructive	payment.transfers.destroy	PUT /v2/transfer/ted/:uid/cancel	Cancels a TED before the bank sends it, typically a scheduled one.
banking_transfer_ted_approve	destructive	payment.transfer_batches.approve	PUT /v2/transfer/ted/:uid/approve	Releases (approves) a TED registered at the bank and waiting for approval, so the bank sends it.
banking_transfer_ted_reschedule	destructive	payment.transfers.update	PUT /v2/transfer/ted/:uid/reschedule	Moves a scheduled TED transfer to another date.

Transferência Pix

Escopo: banking/transfer.transfers ou banking/transfer.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_pix_list	read	payment.transfers.basic	GET /v2/transfer/pix	Lists the Pix transfers the account sent or scheduled, newest first.
banking_transfer_pix_get	read	payment.transfers.basic	GET /v2/transfer/pix/:uid	Returns every field of one Pix transfer, including its destination and its status at the bank, in the same shape as the API v2.
banking_transfer_pix_create	destructive	payment.transfers.create	POST /v2/transfer/pix	Sends money from the account by Pix, either to a Pix key (type: key with key and key_type) or to a bank account (type: bank_account with bank_account).
banking_transfer_pix_cancel	destructive	payment.transfers.destroy	PUT /v2/transfer/pix/:uid/cancel	Cancels a Pix transfer before the bank sends it, typically a scheduled one.
banking_transfer_pix_approve	destructive	payment.transfer_batches.approve	PUT /v2/transfer/pix/:uid/approve	Releases (approves) a Pix transfer registered at the bank and waiting for approval, so the bank sends it.
banking_transfer_pix_reschedule	destructive	payment.transfers.update	PUT /v2/transfer/pix/:uid/reschedule	Moves a scheduled Pix transfer to another date.

Transferência interna

Escopo: banking/transfer.transfers ou banking/transfer.internal

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_internal_list	read	payment.transfers.basic	GET /v2/transfer/internal	Lists the internal transfers (between accounts of the same bank) the account sent or scheduled, newest first.
banking_transfer_internal_get	read	payment.transfers.basic	GET /v2/transfer/internal/:uid	Returns every field of one internal transfer, including its destination and its status at the bank, in the same shape as the API v2.
banking_transfer_internal_create	destructive	payment.transfers.create	POST /v2/transfer/internal	Sends money from the account to another account at the same bank as the financial account the money leaves from (internal).
banking_transfer_internal_cancel	destructive	payment.transfers.destroy	PUT /v2/transfer/internal/:uid/cancel	Cancels an internal transfer before the bank sends it, typically a scheduled one.
banking_transfer_internal_approve	destructive	payment.transfer_batches.approve	PUT /v2/transfer/internal/:uid/approve	Releases (approves) an internal transfer registered at the bank and waiting for approval, so the bank sends it.
banking_transfer_internal_reschedule	destructive	payment.transfers.update	PUT /v2/transfer/internal/:uid/reschedule	Moves a scheduled internal transfer to another date.

Lotes de transferência

Escopo: banking/transfer.transfers ou banking/transfer.batches

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_batch_list	read	payment.transfer_batches.basic	GET /v2/transfer/batches	Lists the transfer batches (lotes de transferência) of the account, of every kind (TED, Pix, internal), newest first.
banking_transfer_batch_get	read	payment.transfer_batches.basic	GET /v2/transfer/batches/:uid	Returns one transfer batch with its status at the bank and every transfer in it, in the same shape as the API v2.
banking_transfer_batch_approve	destructive	payment.transfer_batches.approve	PUT /v2/transfer/batches/:uid/approve	Releases (approves) a transfer batch registered at the bank and waiting for approval, so the bank sends every transfer in it.
banking_transfer_batch_reprove	destructive	payment.transfer_batches.reprove	PUT /v2/transfer/batches/:uid/reprove	Rejects (reproves) a transfer batch waiting for approval at the bank, so none of its transfers is sent.
banking_transfer_batch_cancel	destructive	payment.transfer_batches.destroy	PUT /v2/transfer/batches/:uid/cancel	Cancels a transfer batch.

Lotes de TED

Escopo: banking/transfer.transfers ou banking/transfer.ted

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_ted_batch_create	destructive	payment.transfer_batches.create	POST /v2/transfer/ted_batches	Creates a batch that sends several TEDs together, from new transfers described here and/or existing TED transfers of the account given by uid.

Lotes de transferência Pix

Escopo: banking/transfer.transfers ou banking/transfer.pix

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_pix_batch_create	destructive	payment.transfer_batches.create	POST /v2/transfer/pix_batches	Creates a batch that sends several Pix transfers together, from new transfers described here (to a Pix key or to a bank account) and/or existing Pix transfers of the account given by uid.

Lotes de transferência interna

Escopo: banking/transfer.transfers ou banking/transfer.internal

Tool	Tipo	Permissão	Espelha	O que faz
banking_transfer_internal_batch_create	destructive	payment.transfer_batches.create	POST /v2/transfer/internal_batches	Creates a batch that sends several internal transfers (to accounts at the same bank) together, from new transfers described here and/or existing internal transfers of the account given by uid.

Contas de transferência

Escopo: banking/transfer.transfers ou banking/transfer.accounts

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

---

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.