Abstra Cash Connect
Pagamentos bancários pela plataforma Abstra Cash Connect: folha, fornecedores, boletos, tributos e contas de consumo; transmissão de arquivo; emissão e gestão de cobrança; consultas.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 25 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_payments_payroll | Pay a payroll in one remittance, each item naming an employee by its settlement_reference with the amount in cents, all debited from a single company bank_account. Returns a canonical order that may fan out into several operations, one per derived settlement route same-institution, TED or PIX. Resubmitting the same reference is idempotent and returns the original order with deduplicated=true. | data: { . reference (string) . bank (string) . bank_account (object) . items (array) } (object) required |
| post_payments_suppliers | Pay suppliers in one remittance, each item carrying the supplier settlement_reference, the amount in cents and an optional transfer detail, all debited from a single company bank_account. Returns a canonical order that may fan out into several operations by settlement route; the reference makes the submission idempotent. | data: { . reference (string) . bank (string) . bank_account (object) . items (array) } (object) required |
| post_payments_boletos | Pay boletos cash-out in one remittance, each item settling a boleto by its barcode with optional due date, discount and surcharge. This pays boletos rather than issuing them — use POST /collections for cash-in. Returns a canonical order that may fan out by settlement route, idempotent on the reference. | data: { . reference (string) . bank (string) . bank_account (object) . items (array) } (object) required |
| post_payments_taxes | Collect taxes in one remittance, each item naming the tax by its settlement_reference with the amount in cents, all debited from a single company bank_account. Returns a canonical order that may fan out into several operations by settlement route; resubmitting the same reference is idempotent. | data: { . reference (string) . bank (string) . bank_account (object) . items (array) } (object) required |
| post_payments_utilities | Pay utility bills consumption invoices in one remittance, each item settling a convenio barcode with an optional due date. Returns a canonical order that may fan out by settlement route, idempotent on the reference. | data: { . reference (string) . bank (string) . bank_account (object) . items (array) } (object) required |
| post_accounts_statements | Read an account statement synchronously: name the bank, the company bank_account and a period, and get back the entries that moved, each with its date, amount, direction credit or debit and description. The answer is the data itself and none of it is kept on this side; a bank that only answers by file refuses with not_in_the_call. | data: { . bank (string) . bank_account (object) . period (object) } (object) required |
| post_payments_inquiries | Ask synchronously what became of payments already sent, over an optional period, returning one outcome per bank item — settled, scheduled, rejected or undecided — with its settled amount, timestamp and any rejection reason. The answer is not kept on this side; a bank that only answers by file refuses with not_in_the_call. | data: { . bank (string) . bank_account (object) . period (object) } (object) required |
| post_collections_inquiries | Ask synchronously what became of one collection already issued, named by exactly one of collection_id or own_number. Returns the boleto as read from the bank — status, digitable line, barcode and any paid amount and date — and, unlike the other two inquiries, this reading is kept. A bank that only answers by file refuses with not_in_the_call. | data: { . bank (string) . bank_account (object) . collection_id (string) . own_number (string) } (object) required |
| post_files_upload_authorizations | Ask where to put a ready-made file: naming only the bank, get back a file_id and a presigned PUT url valid for 15 minutes. The bytes never travel through this API — the project PUTs them straight to storage — and the file_id names the file back to us in the transmission call that follows. | data: { . bank (string) } (object) required |
| post_files_return_inquiries | Ask for what the bank gave back for a file already transmitted, over an optional period, in the file-exchange mode where the company assembles the file and we only carry it. Returns a canonical order; when a return is ready its artifact is exchanged for a fresh download url here. | data: { . reference (string) . bank (string) . bank_account (object) . period (object) } (object) required |
| post_files_transmissions | Transmit a file already uploaded, naming its file_id and a fingerprint the server checks against the bytes in storage — a mismatch refuses with fingerprint_mismatch and nothing there with file_absent. Only a verified file reaches the bank; returns a canonical order. | data: { . reference (string) . bank (string) . file (object) } (object) required |
| post_remittance_drafts | Begins the draft state machine; a draft and the order it becomes are the same record at different stages. Pick one of the five payment services payroll, supplier_payment, boleto_payment, tax_payment, utility_payment, the bank, and the company debit account. Returns a draft_id you then fill with items and close. The draft is opened in the caller identity’s bank environment, which every later call must match. | data: { . reference (string) . service (string) . bank (string) . bank_account (object) } (object) required |
| get_remittance_drafts_by_draft | Reads the draft header only: its reference, service, bank, debit account, created and expiry timestamps, the running item_count and the accumulated amount. Use it to check where a draft stands before adding more or closing it. Like every draft call it reads the draft first, and a draft that lives in a different bank environment than the caller is reported as draft_absent. | draft (string) required |
| patch_remittance_drafts_by_draft | Corrects the header of an open draft; only the debit bank_account may change, since service and bank are fixed at the start. Use it before closing when the account was set wrong. It fails with draft_absent when the draft does not exist for this caller, or draft_closed once the draft has already turned into an order. | draft (string) required data: { . bank_account (object) } (object) required |
| delete_remittance_drafts_by_draft | Discards an open draft that will not be sent, abandoning the remittance instead of closing it. Use it to drop a draft built by mistake so it never becomes an order. A draft already closed into an order cannot be thrown away and returns draft_closed. | draft (string) required |
| post_remittance_drafts_by_draft_items | Appends payment items to an open draft, the main step in the assembly loop. Each item carries a required reference plus its amount, settlement_reference and the matching payment detail. Returns one verdict per item: accepted with an item_id, or refused with duplicate_reference, amount_not_positive or item_absent. Keep appending, paging, editing and removing until the draft is ready to close. | draft (string) required data: { . items (array) } (object) required |
| get_remittance_drafts_by_draft_items | Reads the items already in the draft, paginated with after and most 1–1000, default 100. Returns each stored item with its item_id, reference, amount, settlement_reference and payment detail, plus a next_cursor while more pages remain. Use it to review what was appended before closing the draft. | draft (string) required after (string) most (integer) |
| patch_remittance_drafts_by_draft_items | Edits items in place within an open draft: an item that carries an item_id overwrites that one, and an item without an item_id is inserted as new. Returns the same per-item verdicts as appending accepted or refused. Use it to fix items already in the draft without emptying and rebuilding it. | draft (string) required data: { . items (array) } (object) required |
| delete_remittance_drafts_by_draft_items | Removes items from an open draft by their item_id. Returns the ids that were actually taken out. Use it to drop items appended by mistake before the draft is closed into an order. | draft (string) required data: { . items (array) } (object) required |
| post_remittance_drafts_by_draft_closing | Closes the draft: the same record becomes an order and is submitted, spawning one operation per derived settlement route. It takes no body and is idempotent by the draft’s reference, so closing again returns the order already made instead of a second one. A draft with no items pays nobody and is refused with draft_empty. | draft (string) required |
| post_collections | Issue a collection boleto, the one cash-in service, naming the payer, the amount in cents, the due date and the company bank_account where the money lands. Registration is synchronous, but status, digitable_line and barcode stay absent until the bank answers the registration. Set reconcile=true to have the bank polled once a day up to 60 days past due so you are told when it is paid, written off or expires; left out, nothing is polled. | data: { . reference (string) . bank (string) . bank_account (object) . amount (string) . due_on (string) . own_number (string) . bank_number (string) . reconcile (boolean) . payer (object) } (object) required |
| patch_collections_by_collection | Change a collection already issued, addressed by its id in the path and requiring at least one of a new amount or a new due_on. Returns a canonical order whose operation carries the change to the bank. | collection (string) required data: { . reference (string) . bank (string) . amount (string) . due_on (string) } (object) required |
| post_collections_by_collection_write_off | Write off a collection already issued, addressed by its id in the path, so the bank stops expecting payment. It rides the same machine as a change but alters nothing beyond naming the collection, and returns a canonical order. | collection (string) required data: { . reference (string) . bank (string) } (object) required |
| get_returns | The thin list of return notices, and the primary way to discover what changed. service and bank are required; operation, event, since and after cursor narrow it, with most paging the results 1–1000, default 100. Only the fourteen concrete events are searchable — the .all wildcards are for subscribing, not querying. Each entry says only that something happened return_id, operation_id, operation_kind, event, occurred_at; the rich data is read from GET /operations/operation. | service (string) required bank (string) required operation (string) event (string) since (string) after (string) most (integer) |
| get_operations_by_operation | Reads one operation in full — the rich counterpart to the thin /returns list, and where the real data lives. Returns the operationAnswer: the order reference, service, bank, kind and status, every item with its settlement outcome pending, scheduled, settled or rejected, with settled amounts and rejection codes, and the boleto detail when the operation is a collection. The operation is read before access is decided, so one from another service or bank environment is reported as operation_absent. | operation (string) required |
Webhook Events
This connector emits 17 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.
| Event | Description |
|---|---|
| payment-waiting-release | O lote aguarda liberação no canal do banco. |
| payment-waiting-payment | O lote está datado, aguardando o pagamento. |
| payment-updated | Um ou mais pagamentos mudaram e o lote não fechou. |
| payment-settled | O lote foi liquidado. |
| payment-rejected | O lote foi recusado pelo banco. |
| payment-canceled | O lote foi cancelado. |
| payment-failed | O lote falhou. |
| payment-all | Todos os eventos de pagamento. |
| file-settled | O banco processou o arquivo; há retorno para baixar. |
| file-rejected | O banco recusou o arquivo. |
| file-failed | A transmissão do arquivo falhou. |
| file-all | Todos os eventos de arquivo. |
| boleto-paid | O boleto foi pago. |
| boleto-canceled | O boleto foi baixado/cancelado. |
| boleto-rejected | O registro do boleto foi recusado. |
| boleto-expired | Ninguém pagou e a data-limite passou. |
| boleto-all | Todos os eventos de boleto. |