API template library

U.S. Bank Payee Token+ mock API and live sandbox

A WireMock simulation of U.S. Bank's REST API — covering payee token creation, retrieval, validation, deletion, and bulk upload and download.

Vendor
U.S. Bank
Functionality
Payee data tokenization
Spec version
1.3.0
Endpoints
6
Stubs
7
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 Payee Token Plus

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

Base URL
https://vkdm7.wiremockapi.cloud

POST Bulk upload payee token file

curl -s -X POST 'https://vkdm7.wiremockapi.cloud/payees/bulk-upload' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET Bulk download payee token file

curl -s -X GET 'https://vkdm7.wiremockapi.cloud/payees/bulk-download'

DELETE Delete payee

curl -s -X DELETE 'https://vkdm7.wiremockapi.cloud/payees/your-payeeAccountToken'
Method Path Summary
POST /payees Create a Payee Token.
DELETE /payees/{payeeAccountToken} Delete a payee token by passing in the payee account token.
GET /payees/{payeeAccountToken} Retrieve payee details by passing in payee account token.
GET /payees/{payeeAccountToken}/validate Validate if the payee token is active by passing the payee account token.
GET /payees/bulk-download Download a file containing payee tokens or payee data by documentId.
POST /payees/bulk-upload Upload a file to create or retrieve payees in bulk.

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 Payee Token+ template

Payee Token+ solves a data-hygiene problem: store one opaque token instead of a payee's bank details, then pay over any rail by quoting it. The mock renders that promise concretely. Creating a payee returns a freshly minted token — a UUID under a "1-" version prefix — repeated across six rail blocks in the response: ACH and RTP, Zelle, check, domestic and international wire, and card. One token, every rail. Retrieval resolves the tokens this sandbox has issued and answers Payee not found for the rest, and what a resolved token returns is the full de-tokenized record: routing and account numbers for ACH, a Zelle alias, a postal address for checks, and international wire coordinates down to an IBAN and correspondent-bank identifiers — the sensitive payload the token exists to keep out of your database.

  • Tokenization — payee creation returning one minted token across all six payment-rail blocks
  • De-tokenization — the registry-gated retrieval that expands a token into full payment coordinates
  • Token lifecycle — validation and deletion acknowledgments for any token presented
  • Bulk operations — file-based upload returning a documentId, and download of a payee-token document

Frequently asked questions

Only retrieval. GET on a token is gated on the mint registry — issued tokens expand into the payee record, anything else gets the 404 — while the validate and delete routes acknowledge whatever token the path carries, reporting ACTIVE and Deleted respectively for values that were never issued. The split is useful to know when you write assertions: existence tests belong on the GET, and the other two verbs verify request contracts, not registry state.

Every create mints a distinct token, but they all expand to the same canonical payee — the token is unique, the de-tokenized detail is shared fixture data. Assert on the mapping (the token you quote is the token whose record returns) rather than on per-payee field differences, and populate a private WireMock Cloud copy when tests need distinguishable payees per token.

A base64 field that decodes to a small binary blob opening with a PNG signature rather than rows of payee data — treat it as opaque bytes that exercise your decode-and-store path, not as a parseable export. Its upload counterpart acknowledges any submission with 202 and the same recorded documentId every time, so chain upload-then-download by wiring the id through rather than asserting on its value.

It's the same alias the Disbursements via Zelle template enrolls for its recipient persona, so the two sandboxes can play both halves of one flow: tokenize a payee here, disburse to the matching alias there. For payouts where the recipient chooses the rail themselves instead of the payer storing coordinates, the Payee Choice template models that inversion.

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