API template library

U.S. Bank Integrated Receivables mock API and live sandbox

A WireMock simulation of U.S. Bank's REST API — covering invoice submission and receivables retrieval and search.

Vendor
U.S. Bank
Functionality
Receivables submission and reporting
Spec version
1.0.1
Endpoints
3
Stubs
3
Protocol
REST
Validation
AI-validated Before publication, an AI agent exercised these endpoints against the real U.S. Bank API through WireMock's recording proxy, and the recorded traffic was used to verify each stub's request and response shapes.

Live sandbox · no signup, no API key

US Bank Integrated Receivables

A running WireMock Cloud instance of this template, callable right now from a terminal, a script, or an AI agent.

Base URL
https://ze5md.wiremockapi.cloud

POST Submit invoices

curl -s -X POST 'https://ze5md.wiremockapi.cloud/invoices' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET Get receivables item

curl -s -X GET 'https://ze5md.wiremockapi.cloud/receivables/your-transactionID'

POST Search receivables

curl -s -X POST 'https://ze5md.wiremockapi.cloud/receivables/search' \
  -H 'Content-Type: application/json' \
  -d '{}'
Method Path Summary
POST /invoices Submit an invoice or any other open receivable item.
GET /receivables/{transactionID} Retrieve a completed receivable item based on a transaction ID.
POST /receivables/search Retrieve a list of receivabes based on a search criteria.

Unauthenticated WireMock Cloud demo sandbox for U.S. Bank — not an official U.S. Bank sandbox, and it returns simulated example data only.

What's inside the Integrated Receivables template

Integrated Receivables is U.S. Bank's cash-application product — open invoices go in, matched payments come back out — and the template covers both directions. Submission is minimal by design: an invoice POST acknowledges with a 201 and nothing else. Retrieval is the opposite extreme. The canonical receivable is a $4,231.59 ACH credit from Valuecorp Inc, and its record populates every payment-channel structure the schema knows simultaneously: ACH company and SEC-code detail, a check number, a Cincinnati lockbox, an over-the-counter deposit, RTP remittance text, a masked VISA transaction, and a return block citing R01. No production receivable would carry all of these at once — which is what makes one read of this record a complete tour of the shapes a receivables parser must survive.

  • Invoice intake — open-item submission for invoices and other receivables, acknowledged without a body
  • Receivable retrieval — the by-id read resolving the full multi-channel transaction record
  • Receivables search — criteria-based lookup returning matched transactions with invoice applications
  • Remitter detail — customer numbers, contacts, and applied-versus-billed amounts on each matched invoice

Frequently asked questions

Because the fixture is optimized for parser coverage, not realism. A real payment arrives over one channel and fills one block; this record fills them all so a single read exercises every optional structure your model defines. The corollary: channel-dispatch logic should key on the transactionType field — ACH, here — and never infer the channel from which detail blocks happen to be present, an inference this record is built to break.

There isn't one — the intake acknowledges receipt and stops, so correlation runs on the reference numbers you supplied. The matched invoices inside retrieval and search responses carry primaryReferenceNumber and buyerReferenceNumber fields, and those are your join keys back to the submitted open items. Cash-application integrations should treat that echo, not the intake response, as the confirmation the invoice entered the system.

Treat it as furniture for your pagination UI, not as an iteration contract. The counters describe a five-hundred-row result set parked at page five of twenty, while the body carries a single receivable — so next/previous controls, page indicators, and jump-to-page logic all get an interior page to render, but a loop that walks totalCount rows will starve. Row-accurate paging behavior belongs in a private WireMock Cloud copy.

Both, and deliberately: the fixture superimposes a settled payment and a partial return (reason R01, $100.10 of the original amount) so reconciliation code meets the two states in one record. Production logic decides precedence by comparing the return date against the posting date; here the takeaway is that returns arrive as an enrichment of the transaction, not a separate feed. The bank-account-side view of the same events — BAI-coded activity and an ACH returns feed — lives in the Corporate Account Information template.

Vendor names identify APIs represented by WireMock template sources. This page does not imply vendor endorsement, certification, partnership, or official integration status.