Search results
Found 194 results
...for establishing a Flexible Capital Line of Credit®.
Features
Estimate the borrowing power of the customer’s assets for the Flexible Capital Line of Credit®.
Retrieve the base index name, base index rate, spread rate and all-in rate to include in the estimate.
Validate customer...
Tags: Flexible Capital Line of Credit, liquid asset secured, apply
...only and are subject to credit approval.",
"lineOfCreditDisclosure":"U.S. Bank Flexible Capital Line of Credit<sup>®</sup>: Loan approval is subject to credit approval and program guidelines. Not all loan programs are available in all states for all loan amounts. Interest rate...
...Accounts API:
Checking
Savings
Credit card
Line of credit
Loans
Brokerage/IRA
Details include items such as:
Account type
Account description
Balances
Interest rate
Loan details
Holdings
Workflow
Example use cases
Interact with authorized consumer data through our Accounts API to provide...
Tags: account management, accounts, checking, savings, credit card, line of credit, loans, mortgage, brokerage, IRA, retirement, investments
...information, including checking, savings and credit lines.
Call the Accounts and Statements APIs, {accountId} to obtain details on spending habits.
Recommend a savings account balance
Use the Accounts API to determine if a savings account is present.
Get the current balance of the savings...
Tags: data, account aggregation, applications, account management, accounts, checking, savings, credit card, line of credit, loans, mortgage, brokerage, tax, financial health, risk, payoff, OAuth
...information including checking, savings and credit lines.
Call the Accounts and Statements APIs using {accountId} to obtain details on spending habits.
How to make a recommendation on savings account balance
Use the Accounts API to determine if a savings account is present.
Get the current...
Tags: data, account aggregation, applications, account management, accounts, checking, savings, credit card, line of credit, loans, mortgage, brokerage, tax, financial health, risk, payoff, OAuth
...card. For accounts, it is the maximum amount of credit for the account.
Outstanding Authorizations
Total amount of authorized transactions not yet matched and posted to the card or account. The Available Credit value has been adjusted for this amount. (Not available for Managing accounts.)
The...
...payment:
Field
Description
comments[]
Up to 5 lines of comments.
customAttributes[]
Up to 20 'name:value' pairs. A limited number are included in the system-managed remittance. Note: The 'name' is case-sensitive and must match a name that has been previously configured. It cannot be dynamically...
...check
080
Credit Card Check
081
Participant Line of Credit Check
082
Participant Home Equity Check
084
Participant Broker Check
090
AMEX declined OR Travelers or Gift Cheque declined by AMEX
091
Call AMEX for info at 866.875.5801
092
AMEX approved OR Travelers or Gift Cheque approved by...
...check
080
Credit Card Check
081
Participant Line of Credit Check
082
Participant Home Equity Check
084
Participant Broker Check
090
AMEX declined OR Travelers or Gift Cheque declined by AMEX
091
Call AMEX for info at 866.875.5801
092
AMEX approved OR Travelers or Gift Cheque approved by...
...check
080
Credit Card Check
081
Participant Line of Credit Check
082
Participant Home Equity Check
084
Participant Broker Check
090
AMEX declined OR Travelers or Gift Cheque declined by AMEX
091
Call AMEX for info at 866.875.5801
092
AMEX approved OR Travelers or Gift Cheque approved by...
...when you use our Transactions API.
Savings
Line of credit
Loans
Investments
For checking and savings accounts, transaction details include:
Amount
Type
Time stamp
Category
Check number
Description
Payee
For brokerage and investment accounts, transaction details include:
Type
Shares
Price
Face...
Tags: transactions, accounts, checking, savings, aggregator, account aggregation, data toolbox
...types such as:
Checking
Savings
Credit card
Line of credit
Loans
Brokerage/IRA
Retrieve tax documents and receive PDF versions of tax forms including:
1098
1099-INT
1099-DIV
Workflow
Example use cases
Interact with authorized consumer data through our Documents API to provide value-added...
Tags: tax document, tax, loan, mortgage, PDF, credit, checking, savings, data toolbox
...U.S. Bank initiates the wire transfer on behalf of one of their customers. The sender is the financial institution, and the ordering customer is the financial institution’s customer. The ordering customer’s name, address and bank account information are required in the orderingCustomerDetails...
...Beneficiary Line 3",
"Originator to Beneficiary Line 4"
],
"additionalInformationLines": [
"Bank to Bank Information Line 1",
"Bank to Bank Information Line 2",
"Bank to Bank Information Line 3",
"Bank to Bank Information Line 4"
]
}
}
}
Sample response
Status...
...over time in relation to their sales cycle and credit line leverage. Sandra uses the Corporate Account Information API to help her pull U.S. Bank deposit account balances, perform the analysis needed to assess previous transactions data, and predict financial spending.
Restrictions
Deposit...
Tags: corporate accounts, treasury reporting, cash positioning
...over time in relation to a sales cycle and credit line leverage. The Corporate Account Information API helps the manager pull U.S. Bank deposit account balances, perform the analysis needed to assess previous transactions data, and predict financial spending.
Restrictions
Deposit account...
Tags: corporate accounts, treasury reporting, cash positioning
...1.0
© 2022 U.S. Bank
"Flexible Capital Line of Credit®" and "Flexible Capital Platform®" is a registered trademarks of U.S. Bank
Here's what's new in the Flexible Capital Platform®!
This is the inaugural release of the Flexible Capital Platform® product.
Revision...
...logo and other items (using a predefined set of templates).
Future enhancements
Retrieve paid check images.
Manage exception items by integrating with our Positive Pay API.
Workflow
Example use cases
Retrieve issued check details and status.
Jane processes claims for a major insurance company....
Tags: checks, payables, payments
...Card” refers to a comprehensive collection of credit card capabilities. This service enables applications to manage the entire credit card lifecycle, including issuing new cards, setting limits and controls, and closing accounts.
To use this API, one must participate in a U.S. Bank corporate...
...{
"addressLine1": "123 Main St",
"addressLine2": "Unit 1",
"addressLine3": " ",
"city": "San Francisco",
"state": "CA",
"zipCode": "94111",
"country": "UNITED STATES",
"countryCode": "US"
}
},
"checkDetails": {
"checkNumber": 1001,
"checkEffectiveDate": "2022-04-07",
"amount":...
...sequence diagram below is a sample sequence of Access Online Transaction and Order API requests (and is not exhaustive). The workflow includes these significant steps:
The OAuth API is used to obtain a temporary access token
The access token is used to retrieve a transaction
The access token...
...{
"addressLine1": "123 Main St",
"addressLine2": "Unit 1",
"addressLine3": " ",
"city": "San Francisco",
"state": "CA",
"zipCode": 94111,
"country": "US"
}
},
"checkDetails": {
"checkNumber": 1001,
"checkEffectiveDate": "2021-09-17",
"amount": 1200.13,
"currencyCode": "USD"
...
...credit transfer and retrieve the details of the credit transfer transaction.
Initiate payment request and share the transaction id.
Process payment request and retrieve the details of the payment request transaction.
Sandbox environments accept JSON-encoded request bodies and return...
...credit transfer and retrieve the details of the credit transfer transaction.
Initiate payment request and share the transaction id.
Process payment request and retrieve the details of the payment request transaction.
Sandbox environments accept JSON-encoded request bodies and return...
...check details and status.
Retrieve a history of checks submitted up to 12 months in the past using search.
Cancel a submitted check before hourly processing.
Track checks from origination through processing via webhooks.
Customize checks with your logo and other items using a predefined set of...
Tags: checks, payables, payments
..."USD",
"originalCurrencyCode": "USD"
},
"lineOfBusiness": null,
"accountNumber": "00000000000182375057375",
"accountNumberDisplay": null,
"routingTransitNumber": "00075000022",
"balanceType": "ASSET",
"interestRate": 0,
"interestRateType": null,
"interestRateAsOf": null,
...
..."USD",
"originalCurrencyCode": "USD"
},
"lineOfBusiness": null,
"accountNumber": "00000000000182375057375",
"accountNumberDisplay": null,
"routingTransitNumber": "00075000022",
"balanceType": "ASSET",
"interestRate": 0,
"interestRateType": null,
"interestRateAsOf": null,
...
...logo and other items (using a predefined set of templates).
Future enhancements
Retrieve paid check images.
Manage exception items by integrating with our Positive Pay API.
Workflow
Example use cases
Retrieve issued check details and status.
Jane processes claims for a major insurance company....
Tags: checks, payables, payments
...applications to retrieve the status and details of an RTP credit transfer
GET /credit-transfers/{transactionID}
Initiate a Request for Payment
Initiate an RTP Request for Payment (RfP)
POST /requests-for-payment
Retrieve Request for Payment Details
Retrieve status and details of a sent RfP
GET...
...applications to retrieve the status and details of an RTP credit transfer
GET /credit-transfers/{transactionID}
Check if the recipient's bank is part of the RTP Network
Check if the recipient's bank routing number is part of the RTP Network.
GET/rtp-eligibility-check
POST /credit-transfers
Allows...
...credit Micro-Entries.
The total amount of the credit Micro-Entry (or entries) must be equal to or greater than the value of the debit Micro-Entry (or entries).
Originators must send the debits and the corresponding credit Micro-Entries simultaneously for settlement at the same time.
The...
...credit Micro-Entries.
The total amount of the credit Micro-Entry (or entries) must be equal to or greater than the value of the debit Micro-Entry (or entries).
Originators must send the debits and the corresponding credit Micro-Entries simultaneously for settlement at the same time.
The...
...credit transfer limits for the RTP® Network are $100,000 per transaction.
The receiving bank must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Credit push only.
Tags: payments, RTP, disbursements, transfers
...in their payroll system.
Restrictions
Transaction limit is $1 million per transaction.
The receiving bank must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Credit push only.
Tags: payments, RTP, disbursements, transfers, receivables
...use cases
Some real-world capabilities of the Corporate Credit Cards API include:
View whether an employee has an active card account in your ERP, HR Management system or Partner System.
Temporarily suspend an account if a card is lost.
Close a corporate or commercial card account as...
Tags: maintenance, cardholder, corporate, purchasing, One Card, card, commercial, government, API, Access Online, AccessOnline, HR Integration, credit limit, MCCG, MCC, status, account, easy button, Commercial Rewards
..."totalCredits": 186810591.76,
"numberOfCredits": 89,
"totalDebits": 10591.76,
"numberOfDebits": 8,
"accessibleBalance": 10591.76,
"balanceAsOfDate": "2020-05-03T00:00:00.000Z"
}
],
"warnings": [
{
"code": "200.3202",
"message": "Some accounts provided in the accountID...
...and savings accounts with data from thousands of trusted financial institutions.
Use one of three account validation responses.
Basic response (recommended)
Returns account status based on routing and account numbers and ownership verification including an overall match score.
A fast and...
Tags: account validation, payments, risk mitigation
...transfer limits for the RTP® Network limits are $100,000 per transaction.
The receiving bank must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Tags: payments, RTP, disbursements, transfers, receivables
...credit transfer and retrieve the details of the credit transfer transaction.
Initiate payment request and share the transaction id.
Process payment request and retrieve the details of the payment request transaction.
Sandbox environments accept JSON-encoded request bodies and return...
...and velocity controls.
Streamline the extension of corporate credit.
Attach receipt images to cards and authorizations.
Workflow
Example use cases
Reconcile instant transactions.
A passenger is traveling on a major airline that is experiencing delays, causing the passenger to miss the last...
Tags: digital card, mobile payments, mobile wallet, virtual card, virtual payments, virtual credit card payments, payments, payments innovation, security, control, corporate purchasing, corporate expenses, Apple Pay, Google Pay
...is our pleasure to announce the initial release of Corporate Credit Cards API! It allows applications to create and manage credit cards for a company or clients, including multiple spending controls, and offers a rich set of capabilities:
Set up new account
Find accounts
Read account...
...and private keys.
.pfx
PFX was the predecessor of PKCS#12. This type of file usually contains data in PKCS#12 format (e.g., with PFX files generated in IIS).
Instructions on how to convert from one format to another are in the Frequently Asked Questions.
Configure the digital certificate using...
...through access to a nationally-shared database of checking and savings accounts with data from thousands of trusted financial institutions.
Workflow
Example use cases
Scenario one:
George is a customer service representative for the local cable company. He’s speaking with Joanne, a customer...
Tags: account validation, fraud prevention, payments, risk mitigation
...within seconds.
Restrictions
Current credit transfer limits for the RTP® Network are $100,000 per transaction.
Receiving bank of the transaction must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Tags: payments, RTP, disbursements, transfers, receivables
...business or life needs.
Restrictions
Transaction limit is $1 million per transaction.
The receiving bank must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Credit push only.
Tags: payments, RTP, disbursements, transfers, receivables
...the Wire Drawdowns API.
Fund accounts for each line of business.
A finance manager who works for a multinational firm with banking relationships with multiple major banks manages the capital needed for operations. The finance manager can schedule wire drawdown requests to withdraw funds from a...
Tags: domestic, wire, drawdowns, reverse wires
...supplier, the accountant learns they have a $25 credit on their account from a previous overpayment. The accountant and the supplier agree to apply the credit to this payment and the existing virtual card payment can be closed. The company's AP system is connected to Access Online via API, so...
Tags: virtual cards, virtual payments, payables, commercial cards, B2B payments
...is an administrator at the bursar's office of a university. He manages periodic scholarship disbursements to several qualified students each semester. The university's ERP system, which he uses to manage scholarship disbursements, requires him to enter the ACH account information of...
Tags: payee tokenization, payee token management, payment information, ACH, RTP, Zelle, domestic wires, international wires, cards, checks
...the media type of the source
On-Behalf-Of
header
string
The U.S. Bank customer ID if the API request is submitted by a service provider on behalf of the customer. This field is conditionally required.
*= Required items
Request URL
POST /invoices
Sample Request
{
...
..."USD",
"originalCurrencyCode": "USD"
},
"lineOfBusiness": null,
"accountNumber": "00000000000182375057375",
"accountNumberDisplay": null,
"routingTransitNumber": "00075000022",
"balanceType": "ASSET",
"interestRate": 0,
"interestRateType": null,
"interestRateAsOf": null,
...
...standard or same-day speeds. Use tokens in place of account and routing numbers to mitigate the risk of storing recipient bank account details. Retrieve ACH transaction details and cancel a transaction.
Learn more about ACH Originations
RTP® – Real-Time Payments
Implement features from both...
Tags: payments, collections, ACH, disbursements, transfers, corporate accounts, treasury reporting, cash positioning, prepaid cards, checks, disbursements, RTP, disbursements, receivables
...and savings accounts with data from thousands of trusted financial institutions.
Employ one of two response payload types with differing levels of data.
Detailed or Translated
Translated Responses will provide basic information regarding the ownership and/or account.
Detailed Responses provides...
Tags: account validation, payments, risk mitigation
...and savings accounts with data from thousands of trusted financial institutions.
Employ one of two response payload types with differing levels of data.
Detailed or Translated
Translated Responses will provide basic information regarding the ownership and/or account.
Detailed Responses provides...
Tags: account validation, payments, risk mitigation
..."totalCredits": 186810591.76,
"numberOfCredits": 89,
"totalDebits": 10591.76,
"numberOfDebits": 8,
"accessibleBalance": 10591.76,
"balanceAsOfDate": "2020-05-03T00:00:00.000Z"
}
]
}
POST /accounts/previous-day
Get account balances for previous day
Request URL
POST...
...is the inaugural release of the Documents Product and features access to Accounts, Statements and Tax documents information. Documents product is one of several products in the Data Toolbox line.
Revision History
Version
Path
Highlights
Release...
...new in Accounts!
This is the inaugural release of the Accounts Product and features access to Accounts information. Accounts product is one of several products in the Data Toolbox line.
Revision History
Version
Path
Highlights
Release Date
1.0
/account
Initial release
July 31, 2019
...is the inaugural release of the Transactions Product and features access to Accounts and Transactions information. Transactions product is one of several products in the Data Toolbox line.
Revision History
Version
Path
Highlights
Release Date
1.0
/account/transactions
Initial release
July...
.../cards/{cardID}/realtime-credit-details /accounts/{accountUID}/realtime-credit-details /managing-accounts/{accountUID}/realtime-credit-details
- Receive webhook notifications - Retrieve credit details
- Real-time authorizations are available as webhooks. - Read real-time...
...within seconds.
Restrictions
Transaction limit is $1 million per transaction.
The receiving bank must be part of the RTP® network.
Originated credit transfer messages are irrevocable.
Credit push only.
Tags: payments, RTP, disbursements, transfers, receivables
...2022
1.1.0
Added optional structuredRemittanceLines array to support multiple remittance line functionality.
Sep 2021
1.0.2
Updated the recipientName length to 40 characters. Added maxLength to recipientName in the search endpoint. Added information on the clientID parameter usage. Added...
...in Data Toolbox!
This is the inaugural release of the Data Toolbox Product and features access to Accounts, Transactions, Statements and Tax information. Data Toolbox is U.S. Bank flag ship product in the Data Toolbox line.
Revision History
Version
Path
Highlights
Release...
...webhook notificationsRead credit details
Real-time authorizations are available as webhooksRetrieve real-time credit balances, not previous-day balances
Oct 14, 2021
1.2
/cards/{cardID}
Update card
Ability to modify-...
..."addressLine1": "3400 John Olsen Pl",
"addressLine2": "123 n central",
"addressLine3": "test 3",
"city": "Hillsboro",
"state": "OR",
"postalCode": "97124",
"country": "USA"
}
},
"wireDetails": {
"domesticWires": {
"accountNumber": "1234567890",
"routingNumber": "091000022",
...
...callback URI provided by the client at the time of onboarding.
Sample payload of the request body for a call to the callback URI is as follows:
{
"targetUrl": "https://alpha-api.us.bank-dns.com/gtm/money-movement/rtp/v1/credit-transfers/{transactionID}"
"message": "The status of the transaction...
...in development.
For Akoya, "this has been one of the best experiences in terms of getting API connections up and running with a partner," stated Wilson D'Souza, chief technology officer at Akoya.
How does the connection work?
Akoya leverages the U.S. Bank oAuth protocol to generate a secure...
...in development.
For Akoya, "this has been one of the best experiences in terms of getting API connections up and running with a partner," stated Wilson D'Souza, chief technology officer at Akoya.
How does the connection work?
Akoya leverages the U.S. Bank oAuth protocol to generate a secure...
...in development.
For Akoya, "this has been one of the best experiences in terms of getting API connections up and running with a partner," stated Wilson D'Souza, chief technology officer at Akoya.
How does the connection work?
Akoya leverages the U.S. Bank oAuth protocol to generate a secure...
Tags: Innovation, Data toolbox
...NACHA standardized practices and formatting of Micro-Entries as a method of account validation.
Originated payment management
Retrieve submitted ACH transaction details and status.
Cancel a submitted ACH transaction.
Subscription to ACH return and notification of change (NOC) alerts.
Sandbox...
Tags: payments, collections, ACH, disbursements, transfers
...NACHA standardized practices and formatting of Micro-Entries as a method of account validation.
Originated payment management
Retrieve submitted ACH transaction details and status.
Cancel a submitted ACH transaction.
Subscription to ACH return and notification of change (NOC) alerts.
Sandbox...
Tags: payments, collections, ACH, disbursements, transfers
...IBM cloud services.
Your account comes with a credit of USD 200 which can be used on any apps or services that may have a cost associated with them. However, the Watson APIs listed above are currently free of charge.
Note: These links on this page takes you to an external website, which may...
Tags: Innovation, Watson
...payee profile results. Check the status of a payee's profile setup or view their preferred payment type.
Make a payment.
Submit one or more payment instructions in a single request. Payees will be sent payments based on their payment type preference. If payment instructions are received...
Tags: payments, ACH, electronic transfers, prepaid cards, checks, disbursements, transfers
...easy, and simple.
Pay businesses for procurement of supplies.
Refund a customer.
Reimburse employees for expense reports.
Settlement of a claim.
Pay a contractor.
Collect on funds due.
Perfect for:
Enterprise resource planning systems
Accounts payable applications
Insurance or healthcare...
Tags: payments, collections, ACH, disbursements, transfers
...payee profile results.
Check the status of a payee's profile setup or view their preferred payment type.
Retrieve payee details.
Retrieve a payee's contact information, status, activation date, payment preference and any additional payee information included in the API.
Receive payee...
Tags: payments, ACH, electronic transfers, prepaid cards, checks, disbursements, transfers
...Date
1.1.0
Added optional structuredRemittanceLines array to support multiple remittance lines.
September 2021
1.0.2
- Updated the recipientName length to 40 characters.- Added maxLength to recipientName in the search endpoint.- Added information on the clientID parameter usage.- Updated the...
...Bank the flagship product in the Data Toolbox line.
Revision history
Version
Path
Highlights
Release date
1.1
Added new optional request header “requestType” to the API
December 2022
1.0
/accounts/ /account/customer /account/statements/accounts/tax/account/transactions
Initial release.
July...
...Message!
Revision history
Version
Highlights
Release Date
1.2
Updated the webhook subscription request body payload.
February 2023
1.2
Added new webhook payload. No change to the RTP® - Credit Transfer Message v1.2 product specification.
May 2022
1.2
Added new On-behalf-of parameter.
February...
...LIMITATION, DAMAGES TO EQUIPMENT, FOR LOSS OF PROFITS, GOODWILL, USE, DATA, OR OTHER INTANGIBLE LOSSES (EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES), WHETHER CAUSED BY OR RESULTING FROM (1) THE USE OR THE INABILITY TO USE THE DEVELOPER PORTAL/API(S); (2) ANY FAILURE OF PERFORMANCE,...
...are the general non-SCIM characteristics of User Profile API:
User organization detail
User primary organization
User secondary organization
User approval policy level
User approval level
User approval policy level name
User role detail
User role
User contact roles
The non-SCIM API User...
...content type of the payload
On-Behalf-Of*
header
string
Identifier associated with the originating party
pageNumber
query
number
Current Page number
pageSize
query
number
Current Page size
Request Body
{
"searchCriteria": {
"payeeID": "QC01121DAS",
...
...within the hierarchy.
There is a minimum of 1 level and a maximum of 7. The top level consists of a single organization representing all accounts. Lower organizational levels are optional and consist of child organizations that are independent subsets of their parent organization. For...
...time a request is sent, including each retry of a failed request. Often, a GUID is used, but any string value is valid.
Correlation-ID: 7472f69e-c778-4dab-90bc-7314a0d5ac07
Idempotency Key (When and How to Retry a Request)
These APIs require special handling to prevent being processed more...
...within the hierarchy.
There is a minimum of 1 level and a maximum of 7. The top level consists of a single organization representing all accounts. Lower organizational levels are optional, and consist of child organizations that are independent subsets of their parent organization. For...
...refuse to accept any cookies, and the majority of devices and browsers offer additional privacy settings for cookies. You do this through your browser settings. Each device and each browser is a little different, so look at your device settings or your browser Help menu to learn the correct way...
...of Pre-Auth
Time of Completed
Time of Completed*
transDate:
Date of Pre-Auth
Date of Completed
Date of Completed*
transPostedDate:
N/A
N/A
Date of Posted
If there is no Completed event, the Pre-Auth values are used when Posted.
IMPORTANT: When...
...call by the client, allows to trace full path of interactions through multiple sub-systems (GUID).
On-Behalf-Of
header
string
conditional
If the API request is from a service provider on behalf of a U.S Bank customer, then this field will hold the customer ID of the U.S Bank customer. This...
...be downloaded and imported into many REST API software development and test tools to accelerate use of the API.
The specification contains all the necessary information to use each API endpoint, including:
URL for the gateway(s)
Request HTTP method, URI, headers, parameters and JSON...
...content type of the payload
On-Behalf-Of*
header
string
Identifier associated with the originating party
pageNumber
query
number
Current Page number
pageSize
query
number
Current Page size
Request Body:
{
"searchCriteria": {
"payeeID": "QC01121DAS",
...
...request.
Note the required inclusion of scopes as part of the request.
Query parameter
Value
Description
client_id
string
Required - the Issued Consumer Key value.
response_type
string
Required - value should be "code."
redirect_uri
string
Required - the redirect URL that was...
...request.
Note the required inclusion of scopes as part of the request.
Query Parameter
Value
Description
client_id
string
Required - The Issued Consumer Key value
response_type
string
Required - value should be "code"
redirect_uri
string
Required - The redirect URL that was registered...
...request.
Note the required inclusion of scopes as part of the request.
Query Parameter
Value
Description
client_id
string
Required - The Issued Consumer Key value
response_type
string
Required - value should be "code"
redirect_uri
string
Required - The redirect URL that was registered...
...request.
Note the required inclusion of scopes as part of the request.
Query Parameter
Value
Description
client_id
string
Required - The Issued Consumer Key value
response_type
string
Required - value should be "code"
redirect_uri
string
Required - The redirect URL that was registered...
...request.
Note the required inclusion of scopes as part of the request.
Query Parameter
Value
Description
client_id
string
Required - The Issued Consumer Key value
response_type
string
Required - value should be "code"
redirect_uri
string
Required - The redirect URL that was registered...
...be downloaded and imported into many REST API software development and test tools to accelerate use of the API.
The specification contains all the necessary information to use each API endpoint, including:
URL for the gateway(s)
Request HTTP method, URI, headers, parameters and JSON...
...- Get notifications on the availability of Positive Pay exceptions
The purpose of Positive Pay Webhook API is to send webhook notifications to customers for Positive Pay events s at different timezones depending on where the customer is located at.There are three types of events that are...
...{
"addressLine1": "123 Main St",
"addressLine2": "Unit 1",
"addressLine3": " ",
"city": "San Francisco",
"state": "CA",
"zipCode": 94111,
"country": "US"
}
},
"checkDetails": {
"checkNumber": 1001,
"checkEffectiveDate": "2021-08-06",
"amount": 1200.13,
"currencyCode": "USD"
...
...GET /bank-holidays
Note right of B: If valid token,return list of holidays
B->>+C: Search by year
C->>C: If granted access, search holidays by year
C-->>-B: Search results
B-->>-A: get /bank-holidays
Note over A: Check date is a holiday
A->>+B:...
..."USD",
"originalCurrencyCode": "USD"
},
"lineOfBusiness": null,
"accountNumber": "00000000000182375057375",
"accountNumberDisplay": null,
"routingTransitNumber": "00075000022",
"balanceType": "ASSET",
"interestRate": 0,
"interestRateType": null,
"interestRateAsOf": null,
...
..."Lincoln",
"recipientAddress": {
"addressLine1": "100 Main St",
"addressLine2": "Apt 116",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"country": "US"
}
},
"paymentDetail": {
"payFromAccountNumber": 156041200221,
"amount": 500.17,
"priorityType": "INSTANT",
"memo":...
..."Lincoln",
"recipientAddress": {
"addressLine1": "100 Main St",
"addressLine2": "Apt 116",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"country": "US"
}
},
"paymentDetail": {
"payFromAccountNumber": 156041200221,
"amount": 15.17,
"priorityType": "INSTANT",
"memo":...
...the process changes,” Peterson said. “Word of mouth quickly spread and helped convert some of the skeptics on our team. Once people started to see how easy and fast the payments were, everyone was on board.”
While Sunriver initially used Zelle for realtor commission payments, Peterson...
Tags: Innovation, Faster payments, Zelle
...subscription
You can subscribe to notifications of Return & NOC events. During onboarding, you will be asked to supply both a test and a production URI where the notifications will be sent. The payload sent to the callback URI will be as follows:
{
"targetUrl":...
..."USD",
"originalCurrencyCode": "USD"
},
"lineOfBusiness": null,
"accountNumber": "00000000000182375057375",
"accountNumberDisplay": null,
"routingTransitNumber": "00075000022",
"balanceType": "ASSET",
"interestRate": 0,
"interestRateType": null,
"interestRateAsOf": null,
...
...ticket varies slightly depending on which of the three issue types you select. Only fields marked as Optional are not required. See the We’re here to support you section of this guide for specific instructions on submitting your support request ticket.
Access your account...
...“customerReference” and “PAR” parameters.
December 2021
1.1.0
Added "orderingCustomerDetails" object to the following endpoints:- Request body of "Initiate a Domestic Wire Transfer"- Request body of "Initiate an International Wire Transfer"- Response body of "Retrieve...
...of her time tracking down the payment status of invoices. As she increases the number of accounts she manages, she needs a better way to receive this information so that she can spend time on more valuable tasks. She can use the U.S. Bank Freight Payment Transactions API to quickly retrieve...
Tags: freight payment, freight, shipment, order
..."53",
"returnScoreFactorMessage2": "Number of transactions is out of pattern compared with history",
"returnScoreFactorCode3": "54",
"returnScoreFactorMessage3": "Return history",
"returnReasonCode": "03",
"returnReasonMessage": "Insufficient Funds",
"lastUpdate": 20210914,
...
...the account ownership and status of an of an external account and invoke EWS AOA service, run rules on response.
Parameters
Parameter
Type
Data Type
Description
Accept*
header
string
Default: "application/json"
Accept-Encoding
header
string
Default:...
...the account ownership and status of an of an external account and invoke EWS AOA service, run rules on response.
Parameters
Parameter
Type
Data Type
Description
Accept*
header
string
Default: "application/json"
Accept-Encoding
header
string
Default:...
...the account ownership and status of an of an external account and invoke EWS AOA service, run rules on response.
Parameters
Parameter
Type
Data Type
Description
Accept*
header
string
Default: "application/json"
Accept-Encoding
header
string
Default:...
...party. This security measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
API client credentials are used to identify an API...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Account Transfers API...
...verified in Voyager. This API eliminates hours of daily processing and boosts productivity.
Monitor transactions for suspicious activity.
Each day, a data analyst receives a log of all card transactions from the previous day for the entire fleet. A representative reviews the log for denied or...
Tags: Voyager, fleet, card, driver, vehicle, account management, fleet management
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Payee Choice API clients...
...that the development team started using the Voyager Vehicles API, which allows him to easily keep the company’s fleet app synchronized with the Voyager system by obtaining an inventory of existing cards and vehicles. This allows Emmet to pull data and information for his audit immediately and...
Tags: Voyager, Voyager card, card, account management, fleet management, transaction, payment
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. ACH, RTP, Check Payables,...
...party. This security measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
API client credentials are used to identify an API...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Corporate Account...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API Client Credentials
Authentication verifies the identity of the API client. Corporate Account...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication process verifies the identity of the API client. Wire Transfers...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API Client Credentials
Authentication verifies the identity of the API client. Check Payables clients...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API Client Credentials
Authentication verifies the identity of the API client. Account Validation API...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Account Validation API...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Check Payables clients...
...requests, the banker buys and sells a portfolio of international stocks through the brokerage account from an internal equity management application. With simplicity in design and ease of integration, the development team at the firm decided to use the Wire Transfers API. This empowered the...
Tags: domestic, international, wire, transfers
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. ACH Originations API...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. RTP API clients are...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Payee Token+ API clients...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Positive Pay API clients...
...to be transferred via an API call instead of a recurring file transmission, eliminating the need to build a specific file format.
Fetch data via notifications.
Alex is the director of Accounts Receivable for a car dealership. The company is using VantagePointTM to manage its receipts. It is...
Tags: receivables, VantagePoint(TM), open accounts receivable A/R, A/R matching
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. VantagePoint Receivables...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. RTP API clients are...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication process verifies the identity of the API client. Wire Transfers...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. Disbursements via Zelle...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. RTP API clients are...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...started using the Voyager Drivers API, which allows him to easily keep the company’s fleet app synchronized with the Voyager system by obtaining an inventory of existing cards and drivers. This allows Emmet to pull data and information for his audit immediately and he creates a variety of...
Tags: Voyager, Voyager card, card, account management, fleet management, transaction, payment
...17, 2021
Known Problems
Below is a list of known problems we plan to address in a future release, subject to change.
Updating a driver with a null value
Description: If a driver value is updated with null, the value does not change. The behavior of using null to update a value is...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example response:
...
...of token
BearerToken
expiresIn
number
Number of seconds until this token expires
900
accessToken
string
The Bearer access token to be used as the Authorization header value in subsequent requests
EwxKaEeHibaLGRa2cY2DUtcuYDntg8
This is an example...
...measure reduces the risk of unauthorized use of credentials by threat actors and identity-spoofing schemes.
For more information, please see the Mutual Transport Layer Security (mTLS) Guide
API client credentials
Authentication verifies the identity of the API client. ACH Originations API...
...I'd give them an A," Stanger said. "It's one of the most robust APIs we've worked with."
Another unique feature U.S. Bank offers is a credential-exchange endpoint. This enables MX to take their stored credentials and exchange them for an OAuth token allowing the user to stay connected without...
...10, 2021
Known Problems
Below is a list of known problems we plan to address in a future release, subject to change.
Updating a vehicle with a null value
Description: If a vehicle value is updated with null, the value does not change. The behavior of using null to update a value is...
...to manage and report card programs. The Access Online Transactions API allows clients that use Access Online to retrieve transaction details, order details and transaction-specific attachments for reporting and auditing purposes.
Features
Retrieve transactions.
Retrieve complete transaction...
Tags: transactions, orders, attachments, commercial cards
...I'd give them an A," Stanger said. "It's one of the most robust APIs we've worked with."
Another unique feature U.S. Bank offers is a credential-exchange endpoint. This enables MX to take their stored credentials and exchange them for an OAuth token allowing the user to stay connected without...
...use cases
Pay businesses for procurement of supplies.
Steve works for a non-profit organization that helps parents pay for their children's school expenses. Since implementing Disbursements via Zelle, this is a much easier process. Steve can now use either a phone number or email address...
Tags: payments, disbursements, transfers, Zelle
...a customer.
Some shoes that were ordered online never arrived, so the online shopper reached out to the retailer. The retailer’s customer support agent did a little research and found that the shoes were marked as undelivered. The shopper really needed those shoes for a ski trip she was...
Tags: payments, disbursements, transfers, Zelle
...of the access token
accessToken
string
Bearer token to be used as the Authorization value in subsequent requests
expiresIn
number
Number of seconds until this token expires
Sample Response
{
"tokenType": "BearerToken",
"expiresIn": "899",
...
...management is no exception to the growing demand of digital consumers: any device, anywhere, anytime.
Voyager APIs are internet-ready and compatible with a broad range of application platforms:
Cloud services
ERP systems
Fleet management applications
Mobile applications
Voyager transaction data...
Tags: Voyager, Voyager card, card, account management, fleet management, transaction, payment
...I'd give them an A," Stanger said. "It's one of the most robust APIs we've worked with."
Another unique feature U.S. Bank offers is a credential-exchange endpoint. This enables MX to take their stored credentials and exchange them for an OAuth token allowing the user to stay connected without...
Tags: Innovation, Data toolbox
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...by the U.S. Bank Developer Portal?
Regardless of browser choice, we encourage you to update your browsers often. An up-to-date browser provides the most current security safeguards to protect your information, improved performance and navigation, and optimal site functionality.
We support the...
...Since an organization is a collection of accounts, this provides the ability to search for transactions across many accounts - which can greatly reduce the number of search requests and processing time.
The search API has changed from a GET to a POST request, and no longer requires the...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...additional data access to other business units of the company within U.S. Bank Freight Payment. Currently, a separate request must be sent to the U.S. Bank Freight Payment system administrator to make an update of employee status in the U.S. Bank Freight Payment portal. With the Freight Payment...
Tags: freight payment, freight, user, access, authorization
...With the Freight Payment Shipment Order API, the tire retailer can cancel an order that has already been submitted, ensuring the status of orders are always current.
Requirements
Must be an established client or partner of the U.S. Bank Freight Payment Program.
Tags: freight payment, freight, shipment, order
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...in the response of check alias enrollment API call.
See the latest API specification for all the details.
Revision history
Version
Highlights
Release date
1.2
Added the On-Behalf-Of parameter to all endpoints to identify if a provider is connecting on behalf of U.S. Bank customer.
October...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...field to include all unique identifiers of a transaction.Updated the transactionReferenceNumber description in the Corporate Account Information specification to identify the purpose of this attribute. Extracted the additional Information json blob and updated the payload structure to...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...the ability to search for orders within Access Online! There is a rich set of criteria that can be searched over the past 6 years.
Revision History
Version
Basepath
Resource
Highlights
Release Date
1.1
/access-online-transactions/v1
/orders/search
New order search
Sept 2,...
...base64 encoded string consisting of the Consumer Key and Consumer Secret values separated by a colon ':'
Content-type
"application/x-www-form-urlencoded"
Content-Type for the post request
Correlation-ID
Any alphanumerical value
(Optional) Unique id for every request response...
...U.S. Bank
"Voyager" is a registered trademark of U.S. Bank.
What's new in Voyager Cards!
To complete the Voyager Cards API, we’ve added two new endpoints:
Create a card - Issues a physical card. This is the pinnacle of the Voyager Card APIs!
Delete a comment - Removes a logged comment from a...
...in Treasury Builder!
This is the initial release of the Treasury Builder API. The Treasury Builder API is a collection of treasury management APIs, which includes ACH Originations, RTP® – Real-Time Payments, Check Payables, Corporate Account Information and Account Transfers.
Revision...
...notifications via webhooks.
Receive online notifications via webhooks for previous day or same day exceptions requiring review.
Workflow
Example use cases
Manage and process exceptions quickly and all in one place.
In Maren's role, she usually spends a couple of hours a day managing...
Tags: payments, exceptions, fraud prevention, check, ACH
...transfer.
Retrieve the transaction details of a specific transfer.
Search for an account transfer and retrieve the history.
Test API features in a sandbox environment by adding it to a project.
Workflow
Example use cases
Accept income payments.
A municipality manages 10 to 50 subsidiaries,...
Tags: domestic, account, transfers
...specific payment details, search for a list of payments, retrieve specific payee information, and a webhook that notifies when the payment status is changed.
See the latest API specification for all the details.
Revision history
Version
Highlights
Release date
1.0.0
Initial release
June 30,...
...history
Version
Highlights
Release date
1.0
Initial release.
December...
...date
1.1.0
Removed the Idempotency-Key header parameter from the create payee token request.
September 2022
1.0.1
Added the On-Behalf-Of parameter to all endpoints to identify if a SaaS provider is connecting on behalf of a U.S. Bank customer.
June 2022
1.0.0
Initial...
...addresses or mobile phone numbers). Recipients of payments are notified by email or text message to visit either their own trusted banks’ online banking sites or the secure Zelle site to register their aliases and link them to their bank accounts.
The user guide provides instructions and...
Product notes
Version 1.0
© 2021 U.S. Bank
Here's what’s new in Payee Choice API!
This is the inaugural release of the Payee Choice product.
Revision history
Version
Highlights
Release date
1.0
Initial release
June 30, 2021
...User Management API (also known as User Profile)!
The Freight Payment User Management API supports System for Cross-domain Identity Management (SCIM) 2.0, an open standard that allows you to automate user provisioning, using REST API and JSON. Freight applications use the User Profile API...
...excited to announce the initial release of the Freight Payment Transactions API! The Freight Payment Transactions API allows the shipper or carrier to search and retrieve various documents, such as shipment order, invoice detail or e-bills from the U.S. Bank freight system.
Revision...
...'Shipment Order' is also known as a 'Bill of Lading'. A shipper uses this API to order a shipment via a carrier.
Revision history
Version
Resource
Capability
Highlights
Release date
1.1
/orders/{BOLNumber}/cancel
Change state to canceled.
Changed cancel request payload.
January...
...addresses or mobile phone numbers). Recipients of payments are notified by email or text message to visit either their own trusted banks’ online banking sites or the secure Zelle site to register their aliases and link them to their bank accounts.
The user guide provides instructions and...
...added functionality to enhance the usability of the API.
We have added new endpoints to retry a failed payment, to search payments, and to send enrollment invitations.
See the latest API specification for all the details.
Revision History
Version
Highlights
Release Date
1.0
Initial...
...in Check Payables!
This is the inaugural release of the Check Payables Product and features.
Revision history
Version
Highlights
Release Date
1.0.2
- recipientName length updated to 40 chars.- maxLength also added for recipientName in search endpoint.- Added information on the clientID parameter...
...payment dates in bill payee services.
Confirm when a branch is open or closed for holiday hours of operation.
Restrictions
The Bank Holidays API has no restrictions.
Tags: federal holidays, bank holidays, holidays, bank closed dates
...date
1.2
Added On-Behalf-Of parameter to identify the customer when a service provider is the calling application. Updated webhook details.
December 2022
1.1
Added the Micro-Entries capability per NACHA rules.
October 2022
1.1
Added sandbox information to the Ach...
...Originations Developer Guide and Specification.
July 2022
1.1
Added new feature to allow a payee token instead of account and routing number.
August 2021
1.0
Initial release
December 2019
...date
1.3.0
Added the On-Behalf-Of parameter to all endpoints to identify if a provider is connecting on behalf of U.S. Bank customer.
September 2022
1.3.0
Added the basic response as an optional response payload type.
April 2022
1.2.0
- Added additional fields to the translated...