Remessa, retorno e EDI

O ciclo CNAB do boleto — registros, remessas e retornos —, as remessas de pagamento e as caixas EDI que recebem os arquivos do banco.

Famílias nesta página

Família	Tools	read	write	destructive
Registros de boleto	2	2	0	0
Remessas CNAB	4	2	0	2
Boletos em remessa	3	2	0	1
Retornos CNAB	2	2	0	0
Boletos em retorno	2	2	0	0
Remessas de pagamento	1	1	0	0
Caixas EDI	4	2	0	2

Registros de boleto

Escopo: banking/charge.bank_billet_registrations

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_registration_list	read	charge.cnabs.basic	GET /v2/charge/bank_billet_registrations	Lists the registration attempts of the account's bank billets at the bank (registro via API), most recent first, with their status, failures and error message.
banking_charge_bank_billet_registration_get	read	charge.cnabs.basic	GET /v2/charge/bank_billet_registrations/:uid	Returns one registration attempt of a bank billet at the bank, with its status, failure count and error message, in the same shape as the API v2.

Remessas CNAB

Escopo: banking/integration.remittances

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_remittance_list	read	charge.cnabs.basic	GET /v2/charge/remittances	Lists the CNAB remittance files (arquivos de remessa) of the account, most recent first, with their status and whether they were sent to the bank.
banking_charge_remittance_get	read	charge.cnabs.basic	GET /v2/charge/remittances/:uid	Returns one CNAB remittance file (arquivo de remessa) with its status, download URL once processed, and every billet instruction it carries, in the same shape as the API v2.
banking_charge_remittance_create	destructive	charge.cnabs.create	POST /v2/charge/remittances	Generates CNAB remittance files (arquivos de remessa) with the pending billet instructions (see banking_charge_bank_billet_remittance_list): all of a bank billet account (bank_billet_account_uid, up to 3000), or only the given bank_billet_remittance_uids (one file per bank billet account they belong to).
banking_charge_remittance_delete	destructive	charge.cnabs.destroy	DELETE /v2/charge/remittances/:uid	Deletes a CNAB remittance file.

Boletos em remessa

Escopo: banking/integration.remittances

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_remittance_list	read	charge.cnabs.basic	GET /v2/charge/bank_billet_remittances	Lists the CNAB remittance instructions (occurrences such as registration, due date change or write-off) of the account's bank billets, most recent first.
banking_charge_bank_billet_remittance_get	read	charge.cnabs.basic	GET /v2/charge/bank_billet_remittances/:uid	Returns one CNAB remittance instruction of a bank billet, with its occurrence and the remittance file it went into, in the same shape as the API v2.
banking_charge_bank_billet_remittance_delete	destructive	charge.cnabs.destroy	DELETE /v2/charge/bank_billet_remittances/:uid	Removes a pending CNAB remittance instruction of a bank billet, so it is not sent to the bank in the next remittance file.

Retornos CNAB

Escopo: banking/integration.discharges

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_discharge_list	read	charge.cnabs.basic	GET /v2/charge/discharges	Lists the CNAB return files (arquivos de retorno) the account received from its banks, most recent first, with their processing status.
banking_charge_discharge_get	read	charge.cnabs.basic	GET /v2/charge/discharges/:uid	Returns one CNAB return file (arquivo de retorno) with its processing status and every occurrence it reported for the bank billets, in the same shape as the API v2.

Boletos em retorno

Escopo: banking/integration.discharges

Tool	Tipo	Permissão	Espelha	O que faz
banking_charge_bank_billet_discharge_list	read	charge.cnabs.basic	GET /v2/charge/bank_billet_discharges	Lists the occurrences that CNAB return files (arquivos de retorno) reported for the account's bank billets (registration confirmed, paid, rejected...), most recent first.
banking_charge_bank_billet_discharge_get	read	charge.cnabs.basic	GET /v2/charge/bank_billet_discharges/:uid	Returns one occurrence a CNAB return file reported for a bank billet, with its meaning, error detail and the raw and parsed file line, in the same shape as the API v2.

Remessas de pagamento

Escopo: banking/integration.remittances

Tool	Tipo	Permissão	Espelha	O que faz
banking_remittance_payment_get	read	integration.remittances.basic	GET /v2/remittance/payments/:uid	Returns one payment remittance (CNAB file of payments sent to the bank) of the account: file name, status, number, the financial account it belongs to and, once processed, a download link.

Caixas EDI

Escopo: banking/integration.edi_boxes

Tool	Tipo	Permissão	Espelha	O que faz
banking_edi_edi_box_list	read	integration.edi_boxes.basic	GET /v2/edi/edi_boxes	Lists the EDI boxes (CNAB file channels with the banks) of the account, most recent first, with filters that combine.
banking_edi_edi_box_get	read	integration.edi_boxes.basic	GET /v2/edi/edi_boxes/:uid	Returns one EDI box of the account: its account, layout, people, authorization letter status and activation status at the bank, plus a download link for the letter (valid for 48 hours).
banking_edi_edi_box_create	destructive	integration.edi_boxes.create	POST /v2/edi/edi_boxes	Creates an EDI box: the channel through which CNAB files (remittances and returns) of a billet wallet or financial account are exchanged with the bank through a VAN.
banking_edi_edi_box_update	destructive	integration.edi_boxes.update	PUT /v2/edi/edi_boxes/:uid	Changes the fields given of one EDI box (name, layout, people, account); fields left out keep their value.

---

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.