Transaction Broker API

Name: Transaction Broker API API
Brand: Transaction Broker API
Availability: InStock

✓ Official Vendor SpecPaymentsPos Terminalbearer32 EndpointsREST

For Agents

Process card, ACH, and cash transactions, manage stored customer contracts, dispatch jobs to point-of-sale terminals, and reconcile receipts through Bank of America's Transaction Broker.

Quickstart

Get started with Transaction Broker API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"process a card transaction on a bank of america terminal"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Transaction Broker API API.

Process card, ACH, and cash transactions through dispatcher endpoints under /transactions/process/*

Refund, void, capture, reverse, or adjust an existing transaction by its ID

Store tokenised card or ACH contracts per merchant and customer for repeat billing

Generate hosted payment pages for browser-based payment collection

GET STARTED

Start building with Transaction Broker API API

Explore with Jentic

View OpenAPI Document

Bank of America's Transaction Broker is the central system that manages ongoing payment transactions, dispatches them to point-of-sale terminals, returns results, and maintains the mapping between organisations, terminals, and customers. The 32 endpoints cover card, ACH, and cash transaction processing, refunds, voids, captures and reversals, plus contracts (tokenised customer payment instruments), hosted payment pages, scan codes, terminal status, and printable receipts. Three environments are available: production, staging, and sandbox at tb-sandbox.paymentfusion.com.

Use Cases

Patterns agents use Transaction Broker API API for, with concrete tasks.

★ In-Person Retail Checkout

Run in-person checkout at a Bank of America merchant terminal: create a transaction, send it to /transactions/process/card, then poll /transactions/{id} until processing finishes. The Transaction Broker dispatches the work to the named terminal and returns the result, including any cardholder prompts captured by the device. This replaces direct integration with each terminal model.

Create a transaction with POST /transactions, send it to /transactions/process/card with the target terminal, then GET /transactions/{id} until status is final.

Tokenised Recurring Billing

Store a customer's card or ACH instrument once via /merchants/{merchant_id}/contracts/card or /merchants/{merchant_id}/contracts/ach, then charge the contract on each billing cycle without re-collecting payment details. Contracts are scoped per merchant and per customer and can be retrieved, updated, or deleted as the customer's instruments change.

Create a card contract via POST /merchants/{merchant_id}/contracts/card with a token, then charge it on the next cycle by referencing the contract in POST /transactions.

Hosted Payment Pages and Receipts

Generate a hosted payment page (HPP) via POST /hpps and forward the link to the customer for browser-based payment. After processing, render and surface the receipt with GET /transactions/receipt/render or list receipts with GET /receipts. Print jobs can be queued to a connected receipt printer through POST /print_receipts.

Generate an HPP via POST /hpps for $129.99, send the link to the customer, then render the receipt with GET /transactions/receipt/render once payment is captured.

AI Agent Integration via Jentic

An agent built on Jentic can drive an in-person checkout: create the transaction, dispatch to a specific terminal, and watch the result without holding the api_id:api_token credentials. Jentic stores the ISVAuth and TerminalAuth credentials in MAXsystem so the agent never sees the encoded values.

Search Jentic for 'process a transaction broker card payment', load the schema for POST /transactions/process/card, and execute it with the transaction ID and target terminal serial.

Key Endpoints

32 endpoints — bank of america's transaction broker is the central system that manages ongoing payment transactions, dispatches them to point-of-sale terminals, returns results, and maintains the mapping between organisations, terminals, and customers.

METHOD

PATH

DESCRIPTION

POST

/transactions

Create a transaction

POST

/transactions/process/card

Send a card transaction to a terminal for processing

POST

/transactions/refund/card

Refund a card transaction

POST

/transactions/void

Void a transaction

POST

/merchants/{merchant_id}/contracts/card

Create a stored card contract for a customer

POST

/hpps

Generate a hosted payment page

GET

/terminals/status

Get a terminal's status by serial number or client ID

POST

/print_receipts

Create a print receipt job

POST

/transactions

Create a transaction

POST

/transactions/process/card

Send a card transaction to a terminal for processing

POST

/transactions/refund/card

Refund a card transaction

POST

/transactions/void

Void a transaction

POST

/merchants/{merchant_id}/contracts/card

Create a stored card contract for a customer

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Both ISVAuth (api_id:api_token) and TerminalAuth (serial_number:registration_token) credential pairs are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped operation handles; the base64-encoded values never enter agent context or logs.

Intent-based discovery

Agents search Jentic with intents like 'process a card transaction' or 'refund an ACH payment' and Jentic returns the matching Transaction Broker operation with its input schema, so the agent picks the right endpoint without reading the spec.

Time to first call

Direct Transaction Broker integration: 5-10 days including dual-credential auth, terminal dispatch, contract storage, and receipt rendering. Through Jentic: under a day for the wiring — search, load schema, execute. Onboarding to BoA's developer programme remains separate.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Worldline Payment APIs

Direct card processing API for North American merchants without the BoA terminal layer

Choose Bambora when the merchant needs a non-BoA card-not-present processor; choose Transaction Broker when the merchant operates BoA terminals and wants integrated dispatch.

Complementary

Bagisto Shop REST API

E-commerce storefront whose checkout step can hand off to BoA for in-person payment

Use Bagisto for catalog and cart, and route in-person checkout to the Transaction Broker when the merchant uses BoA terminals.

Complementary

BankID CSC API

Norwegian eSign API for legally binding signatures on contracts that precede payment

Use BankID for contract signing in Nordic flows and Bank of America Transaction Broker to capture the resulting payment.

FAQs

Specific to using Transaction Broker API API through Jentic.

What authentication does the Transaction Broker API use?

The API uses two HTTP bearer schemes. ISVAuth carries 'Basic Base64(api_id:api_token)' for organisation-scoped calls and TerminalAuth carries 'Basic Base64(serial_number:registration_token)' for terminal-scoped calls. Both are sent in the Authorization header. Through Jentic, both credential pairs live in the encrypted vault and are injected at execution so the agent never holds them.

Can I process refunds for ACH and cash, not just card?

Yes. POST /transactions/refund/card refunds a card transaction, POST /transactions/refund/ach refunds an ACH transaction, and POST /transactions/refund/cash records a cash refund. Use the original transaction ID in the body and the broker dispatches the refund through the same flow.

What are the rate limits for the Transaction Broker API?

Rate limits are not declared in the OpenAPI spec. Bank of America enforces limits per organisation and terminal; consult https://developer.merchant-services.bankofamerica.com/ and your merchant agreement, and use the sandbox at tb-sandbox.paymentfusion.com for load testing.

How do I run a card payment on a specific terminal through Jentic?

Search Jentic for 'process a transaction broker card payment', load the schema for POST /transactions/process/card, then execute with the transaction ID from POST /transactions and the target terminal serial. Jentic injects ISVAuth and TerminalAuth at execution.

Does the Transaction Broker API support stored payment instruments?

Yes. Use POST /merchants/{merchant_id}/contracts/card to store a tokenised card and POST /merchants/{merchant_id}/contracts/ach to store an ACH instrument. Contracts are retrievable via GET /merchants/{merchant_id}/customers/{customer_id}/contracts and removable via the matching DELETE.

Can I check whether a terminal is online before sending a transaction?

Yes. GET /terminals/status accepts either a serial_number or a client_id and returns the current connectivity status, so the dispatcher can avoid sending a transaction to an offline device.