U.S. Bank Treasury Management (Preview)

Reference

U.S. Bank payments and treasury banking APIs.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	US Bank API Team
URL	https://developer.usbank.com/contact
Email	apisupport@usbank.com

Connector Metadata
Publisher	U.S. Bank
Website	https://developer.usbank.com/
Privacy policy	https://developer.usbank.com/privacy
Categories	Finance

U.S. Bank provides a suite of treasury management api's to create flexible and seamless banking experiences for your organization. Easily connect your ERP and other treasury applications to our Corporate Account Information and RTP® – Real-Time Payments services. Instantly access company accounts, transaction data and initiate and manage real-time payments through The Clearing House RTP® network.

Prerequisites

An account on the U.S. Bank developer portal.
A completed Portal Access form that’s returned to U.S. Bank API Onboarding team.
API credentials from the U.S. Bank API Onboarding team.
SinglePoint user credentials from the U.S. Bank Treasury Management implementation team.

How to get credentials

Sign up to create a U.S Bank Developer Portal account on our Developer Portal. Signing up is easy with on-screen instructions that guide you along the way. If you need help, contact us.
Contact us to request the keys. Enter the message below in the “Message” field on the Contact us form.

“I want to access this API from a Microsoft connector.”
You’ll receive a Portal Access Form from apionboarding@usbank.com Complete the Portal Access Form and return it to U.S. Bank at apionboarding@usbank.com.
Enter the following text in the “Describe how and why your business wants to consume U.S. Bank APIs and/or related data” field on the Portal Access Form:

“I want to access the APIs through the Microsoft connector.”

To use actions related to Corporate Account Information, you must request access to the Corporate Account Information service. To use actions related to RTP® - Real-Time Payments, you must request access to the RTP® - Real-Time Payments service.
The U.S. Bank API Onboarding Team will assign a U.S. Bank Treasury Management Consultant to your organization. The U.S. Bank Treasury Management Consultant or the U.S. Bank API Onboarding Team will contact you to discuss next steps.
Confirm you want to use the connector in the discovery call with the U.S. Bank API Onboarding Team and the U.S. Bank Treasury Sales Team.
Once confirmed, U.S Bank kicks off the implementation process. The API Onboarding Team will send your API credentials to you. A U.S. Bank Treasury Management implementation coordinator will send your SinglePoint credentials to your organization’s SinglePoint administrator.
You’re now ready to use the connector.

Get started with your connector

Corporate Account Information Features

Retrieve lists of company deposit accounts.
Collect detailed account balances for current day and previous day, with collection capability of up to 50 accounts at a time. Balance information includes an available balance, ledger balance and collected balances for previous and current day.
Receive transactions data for an account on a current day and previous day basis. Historical transactions are available up to 60 days with options for an additional retention period of 12 or 24 months.
Retain statements for deposit accounts for up to 12 months.

Example use cases

Reconcile instant transactions

Company A often spends countless hours reconciling payments made from or received in their various U.S. Bank deposit accounts to their internal company systems (e.g., ERP). Using this API, Company A can instantly pull transaction details directly from U.S. Bank into any system to automate the reconciliation process. No need to review transactions online or from bank statements.

Improve cash positioning

Company B would like to maximize their cash flow and only fund accounts when necessary. By using the Corporate Account Information API, they can project cash positions in their U.S. Bank deposit accounts by pulling balance information into their company system (e.g., ERP) and reconciling payments made or received in real time. If an account balance is projected to overdraft, Company B can immediately fund the account with the amount of the overdraft.

View account balances in one place

A manager responsible for managing the company’s cash and approving all major payments to employees, vendors and third parties is often concerned about over drafting accounts and wants to ensure accounts are capitalized prior to payment disbursement. With the Corporate Account Information API, the manager can view U.S. Bank deposit account balances directly from the company system without having to log in to multiple systems to view balances across different accounts and banks.

Improve treasury reporting

A manager maintains an analytics dashboard, which provides vital financial information and insights for the company. The manager wants to understand how deposit account balances fluctuate 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.

RTP Features

Send transfers 24 hours a day, 7 days a week, 365 days a year.
Initiate and manage real-time clearing and settlement of invoices.

Example use cases

Credit transfer messages

Your team of developers need to find a solution to help customers send money. The customers need to send money from their financial accounts to contacts using a transfer money feature. Using the RTP® API, you can allow your customers with U.S. Bank checking accounts to send payments to contacts, anytime, anywhere.

Real-time payment invoices

Your client is a handyman and works with several clients throughout the week. Mailing invoices and waiting for payments to come through is a hassle due to time and tracking. Searching for a solution, you find a software package that includes sending invoices immediately using the RTP® API. Now your client can spend less time tracking invoices and more time on other business or life needs.

RFP Features

Initiate and manage real-time clearing and settlement of invoices.
Verify biller identity and registration with their financial institution.
Send configurable reminders to customers to enhance the real-time payment experience.
Enable future or partial payments.

Example use cases

Link transparency of bills

A customer needs to pay an electric bill. Using the RTP® Request for Payment API, the utility company’s developer team builds a Request for Payment option that notifies the customer a utility payment is due. The customer can easily submit a payment and see the Request for Payment option has completed/has been received.

Provide customers with the most immediate information

A developer for a mid-size company recently implemented the RTP® Request for Payment API. A colleague, who works in accounts payable for the company, has noticed the difference it’s made in working with vendors and partners. They can now receive requests to pay invoices in real time via Request for Payment and can immediately submit a payment in return, completing transactions within seconds.

Known issues and limitations

OAuth MFA required, our API Onboarding team will coordinate generating your SinglePoint and OAuth registrations

Common errors and remedies

Error messages will usually be related to Authentication Issues, verify that your account has access to the Bank Account that requests are being made for. Contact us to speak with the support team and resolve any other issues.

FAQ

Who can use U.S. Bank API products?

Anyone can view an overview of our API products. To view our technical documentation and use our products you need to create an account.

How do I create an account?

Signing up is easy with on-screen instructions that guide you along the way. If you need help, Contact us.

After you create an account, log in to view API product documentation.

What should I do if I didn’t receive the account activation email?

Check your email spam folder. Contact us if you can’t find the account activation email.

Who should I contact if I have a technical question about an API product?

Each API has comprehensive technical documentation to help you along your way on our Developer Portal. Our support team is also available to assist you with any questions or issues you may have via the Support form.

How do I change my username or email address?

Submit the Contact us form and tell us what you need to change. Include your username or email address. We’ll send you an email with next steps.

If I forgot my password, how can I update it?

Go to Forgot password and enter the email address for your account. We’ll send you a link to change it.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Check if receiver's bank is part of the RTP Network	Check if the recipient's bank is part of the RTP Network. Routing number of the receiving bank is required to check RTP eligibility.
Get account balances for an array of accounts for current-day	Get account balances for an array of accounts for current-day.
Get account balances for an array of accounts for previous-day	Get account balances for an array of accounts for previous-day.
Get list of accounts for the authorized customer	Get list of accounts for the authorized customer.
Get transactions of an account for current-day	Get transactions of an account for current-day.
Get transactions of an account for prior business days over a date range	Get transactions of an account for prior business days over a date range.
Initiate an RTP credit transfer Transaction	Allows for applications to initiate an RTP credit transfer. The payer in the credit transfer should be a US Bank customer.
Initiate an RTP request for payment (RFP)	Allows for applications to initiate an RTP request for payment for receiving money in your US Bank account.
Retrieve status and details of a RTP credit transfer Transaction sent	Allows for applications to retrieve the status and details of an RTP credit transfer that was initiated or an incoming credit transfer.
Retrieve status and details of an RFP sent	Allows for applications to retrieve the status and details of an RTP RFP that was initiated.

Check if receiver's bank is part of the RTP Network

Operation ID:: GetRTPEligibility

Check if the recipient's bank is part of the RTP Network. Routing number of the receiving bank is required to check RTP eligibility.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Bank Routing Number to Validate	routingNumber	True	string	9 digit routing number of the receiver's bank

Returns

Provides RTP eligibility information for a routing number

Body: RTPEligibilityResponse

Get account balances for an array of accounts for current-day

Operation ID:: GetAccountBalancesOfCurrentDay

Get account balances for an array of accounts for current-day.

Parameters

Name	Key	Required	Type	Description
Content-Type Header	Content-Type	True	string	Indicates the media-type of the resource.
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
accountID	accountID		array of string	Accounts Unique Identifier
accountNumber	accountNumber		string	Account Number of the authorized customer
routingNumber	routingNumber		string	Routing Number of the authorized customer
accountType	accountType		string	Type of Account
pageNumber	pageNumber		string	Current Page Number from query result to return
pageSize	pageSize		string	Results page size

Returns

Name	Path	Type	Description
accountsSummaryCurrentDay	accountsSummaryCurrentDay	array of AccountSummaryCurrentDay
warnings	warnings	array of Warnings
pageMeta	pageMeta	PageMeta	To minimize response times for requests and generally improve the end-user experience

Get account balances for an array of accounts for previous-day

Operation ID:: GetAccountBalancesOfPreviousDay

Get account balances for an array of accounts for previous-day.

Parameters

Name	Key	Required	Type	Description
Content-Type Header	Content-Type	True	string	Indicates the media-type of the resource.
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
accountID	accountID		array of string	Accounts Unique Identifier
accountNumber	accountNumber		string	Account Number of the authorized customer
routingNumber	routingNumber		string	Routing Number of the authorized customer
accountType	accountType		string	Type of Account
pageNumber	pageNumber		string	Current Page Number from query result to return
pageSize	pageSize		string	Results page size

Returns

Name	Path	Type	Description
accountsSummaryPreviousDay	accountsSummaryPreviousDay	array of AccountSummaryPreviousDay
warnings	warnings	array of Warnings
pageMeta	pageMeta	PageMeta	To minimize response times for requests and generally improve the end-user experience

Get list of accounts for the authorized customer

Operation ID:: GetAccountsList

Get list of accounts for the authorized customer.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Page Number	pageNumber		string	Current Page Number from query result to return
Page Size	pageSize		string	Results page size

Returns

Name	Path	Type	Description
accounts	accounts	array of AccountDescriptor
pageMeta	pageMeta	PageMeta	To minimize response times for requests and generally improve the end-user experience

Get transactions of an account for current-day

Operation ID:: GetTransactionsOfCurrentDay

Get transactions of an account for current-day.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Account Id	accountID	True	string	Unique Account Identifier
Bank Reference Transaction Id	bankReferenceNumber		string	Unique transaction identifier
Page Number	pageNumber		string	Current Page Number from query result to return
Page Size	pageSize		string	Results page size

Returns

Name	Path	Type	Description
transactions	transactions	array of Transaction
lastRefreshedDateTime	lastRefreshedDateTime	lastRefreshedDateTime	ISO 8601 Date format that the data is from.
pageMeta	pageMeta	PageMeta	To minimize response times for requests and generally improve the end-user experience

Get transactions of an account for prior business days over a date range

Operation ID:: GetTransactionsOfPreviousDay

Get transactions of an account for prior business days over a date range.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Account Id	accountID	True	string	Unique Account Identifier
Start Date	startDate		string	Start date/time to retrieve transactions. ISO 8601.
End Date	endDate		string	End date/time to retrieve transactions. ISO 8601.
Page Number	pageNumber		string	Current Page Number from query result to return
Page Size	pageSize		string	Results page size

Returns

Name	Path	Type	Description
transactions	transactions	array of Transaction
pageMeta	pageMeta	PageMeta	To minimize response times for requests and generally improve the end-user experience

Initiate an RTP credit transfer Transaction

Operation ID:: InitiateRTPCreditTransfer

Allows for applications to initiate an RTP credit transfer. The payer in the credit transfer should be a US Bank customer.

Parameters

Name	Key	Required	Type	Description
Content-Type Header	Content-Type	True	string	Indicates the media-type of the resource.
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
clientRequestID	clientRequestID	True	string	Unique identifier defined by the client application for every Credit transfer/ RFP
name	name	True	string	name of the US bank customer who's account will be debited
accountNumber	accountNumber	True	string	Account number of the payer
routingNumber	routingNumber	True	Routing number should pass the check digit validation	US bank routing number
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	Name of the ultimate payer
identifier	identifier		string	Identifier of the ultimate payer
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	name of the payee who's account will be credited
accountNumber	accountNumber	True	string	Account number of the payer
routingNumber	routingNumber	True	Routing number should pass the check digit validation	routing number of the receiving bank
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	Name of the ultimate payee
identifier	identifier		string	Identifier of the ultimate payee
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
amount	amount	True	number	Amount to be transferred. The amount should be formatted with 2 decimal places
paymentType	paymentType	True	string	Type of RTP payment that will allow the sending and receiving bank to process the payment appropriately
remittanceID	remittanceID		string	Remittance Identification from remt.001 to identify the separate remittance advice sent by the Debtor that is associated with the Credit Transfer
email	email		string	Email address where the remittance info was sent
URI	URI		string	URI where the remittance info was sent
additionalInfo	additionalInfo		string	Used to provide additional remittance related information

Returns

Name	Path	Type	Description
transactionID	clientDetails.transactionID	string	Unique identifier assigned by US Bank. This id can be used to retrieve the transaction later
clientRequestID	clientDetails.clientRequestID	string	Unique identifier defined by the client application for every Credit transfer/ RFP

Initiate an RTP request for payment (RFP)

Operation ID:: InitiateRFP

Allows for applications to initiate an RTP request for payment for receiving money in your US Bank account.

Parameters

Name	Key	Required	Type	Description
Content-Type Header	Content-Type	True	string	Indicates the media-type of the resource.
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
clientRequestID	clientRequestID	True	string	Unique identifier defined by the client application for every Credit transfer/ RFP
name	name	True	string	name of the sender
accountNumber	accountNumber	True	string	Account number of the sender
routingNumber	routingNumber	True	Routing number should pass the check digit validation	US bank routing number
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	Name of the ultimate payee
identifier	identifier		string	Identifier of the ultimate payee
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	name of the payer to whom the RFP is being sent
accountNumber	accountNumber	True	string	Account number of the payer
routingNumber	routingNumber	True	Routing number should pass the check digit validation	routing number of the receiving bank
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
name	name	True	string	Name of the ultimate payer
identifier	identifier		string	Identifier of the ultimate payer
addressLine1	addressLine1	True	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2		string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	True	string	Recipient's resident city.
state	state	True	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	True	##### or #####-####	Recipient's resident ZIP code.
country	country	True	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.
amount	amount	True	number	Amount to be transferred. The amount should be formatted with 2 decimal places
paymentType	paymentType	True	string	Type of RTP payment that will allow the sending and receiving bank to process the payment appropriately
requestedExecutionDateTime	requestedExecutionDateTime	True	YYYY-MM-DDThh:mm:ss	Date or Date & time on which the payment is to be executed. Date & time should be provided Eastern Time. If only date is provided, then it is assumed that the payment is to be done by EOD calendar day, ET
expiryDateTime	expiryDateTime	True	YYYY-MM-DDThh:mm:ss	Date or date and time, after which, the debtor isn't allowed to initiate a CT in response to this request. Date & time should be provided as per Eastern Time. Date cant be before execution date
paymentModificationAllowed	paymentModificationAllowed	True	boolean	Indicates if an amount other than the requested amount can be paid or not
remittanceID	remittanceID		string	Remittance Identification from remt.001 to identify the separate remittance advice sent by the Debtor that is associated with the Credit Transfer
email	email		string	Email address where the remittance info was sent
URI	URI		string	URI where the remittance info was sent
additionalInfo	additionalInfo		string	Used to provide additional remittance related information
fullAmount	fullAmount	True	number	Amount before the discount is applied.This field is used to indicate total due amount for bill pay related RFPs
discountedAmount	discountedAmount	True	number	Amount after the discount is applied.This field is used to indicate minimum due amount for bill pay related RFPs

Returns

Name	Path	Type	Description
transactionID	clientDetails.transactionID	string	Unique identifier assigned by US Bank. This id can be used to retrieve the transaction later
clientRequestID	clientDetails.clientRequestID	string	Unique identifier defined by the client application for every Credit transfer/ RFP

Retrieve status and details of a RTP credit transfer Transaction sent

Operation ID:: GetRTPCreditTransfer

Allows for applications to retrieve the status and details of an RTP credit transfer that was initiated or an incoming credit transfer.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Transaction ID being retrieved	transactionID	True	string	Transaction ID associated with the transactions being retrieved.

Returns

Body: TransactionResponse

Retrieve status and details of an RFP sent

Operation ID:: GetRFP

Allows for applications to retrieve the status and details of an RTP RFP that was initiated.

Parameters

Name	Key	Required	Type	Description
Accept Header	Accept	True	string	application/json
Accept-Encoding Header	Accept-Encoding	True	string	Accept-Encoding
Unique identifier for every request response pair	Correlation-ID	True	GUID	Unique identifier for every request response pair
U.S. Bank customer ID this request is for	On-Behalf-Of		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.
Transaction ID being retrieved	transactionID	True	string	Transaction ID associated with the transactions being retrieved.

Returns

Body: RFPDetails

Definitions

Address

Name	Path	Type	Description
addressLine1	addressLine1	string	Main address of the recipient. Include house number, street name, apartment number etc.
addressLine2	addressLine2	string	Main address of the recipient. Include house number, street name, apartment number etc.
city	city	string	Recipient's resident city.
state	state	ISO 3166-2:US	Recipient's resident state.
zipCode	zipCode	##### or #####-####	Recipient's resident ZIP code.
country	country	ISO 3166 CountryCode	Recipient's resident country. Only allowed value is US.

ClientDetails

Name	Path	Type	Description
clientRequestID	clientRequestID	string	Unique identifier defined by the client application for every Credit transfer/ RFP

UltimatePayer

Ultimate payer details incase payer is intermediary. Should only be used for 'INTERMEDIARY' paymentType

Name	Path	Type	Description
name	name	string	Name of the ultimate payer
identifier	identifier	string	Identifier of the ultimate payer
address	address	Address

UltimatePayee

Ultimate payee details incase payee is intermediary. Should only be used for 'INTERMEDIARY' paymentType

Name	Path	Type	Description
name	name	string	Name of the ultimate payee
identifier	identifier	string	Identifier of the ultimate payee
address	address	Address

TransactionResponse

Name	Path	Type	Description
clientDetails	transactiondDetails.clientDetails	ClientDetails
transactionID	transactiondDetails.transactionID	string	Transaction ID of the credit transfer transaction
originalRFPTransactionID	transactiondDetails.originalRFPTransactionID	string	Transaction ID of the original RFP incase the credit transfer is in response to an RFP
transactionType	transactiondDetails.transactionType	string	Whether the transaction is an inbound or an outbound transaction
statusCode	transactiondDetails.status.statusCode	string
message	transactiondDetails.status.message	string	Additional details of the transaction status
amount	transactiondDetails.amount	number	Amount of the transaction
name	transactiondDetails.payerDetails.name	string	Name of the payer
accountNumber	transactiondDetails.payerDetails.accountNumber	string	Last 4 digits of Payer account number that was used for making the payment.
address	transactiondDetails.payerDetails.address	Address
ultimatePayerDetails	transactiondDetails.ultimatePayerDetails	UltimatePayer	Ultimate payer details incase payer is intermediary. Should only be used for 'INTERMEDIARY' paymentType
name	transactiondDetails.payeeDetails.name	string	Name of the payee
accountNumber	transactiondDetails.payeeDetails.accountNumber	string	Last 4 digits of the Account number of the payee
routingNumber	transactiondDetails.payeeDetails.routingNumber	string	Routing number of the payee bank
address	transactiondDetails.payeeDetails.address	Address
ultimatePayeeDetails	transactiondDetails.ultimatePayeeDetails	UltimatePayee	Ultimate payee details incase payee is intermediary. Should only be used for 'INTERMEDIARY' paymentType
remittanceID	transactiondDetails.remittanceData.remittanceID	string	Remittance Identification from remt.001 to identify the separate remittance advice sent by the Debtor that is associated with the Credit Transfer
email	transactiondDetails.remittanceData.remittanceLocationDetails.email	string	Email address where the remittance info was sent
URI	transactiondDetails.remittanceData.remittanceLocationDetails.URI	string	URI where the remittance info was sent
additionalInfo	transactiondDetails.remittanceData.additionalInfo	string	Used to provide additional remittance related information

RFPDetails

Name	Path	Type	Description
clientDetails	requestForPayment.clientDetails	ClientDetails
transactionType	requestForPayment.transactionType	string	Whether the transaction is an inbound or an outbound transaction
statusCode	requestForPayment.status.statusCode	string
message	requestForPayment.status.message	string	Additional details of the transaction
name	requestForPayment.payeeDetails.name	string	name of the sender
accountNumber	requestForPayment.payeeDetails.accountNumber	string	Account number of the sender
routingNumber	requestForPayment.payeeDetails.routingNumber	string	routing number of the sending bank
ultimatePayeeDetails	requestForPayment.ultimatePayeeDetails	UltimatePayee	Ultimate payee details incase payee is intermediary. Should only be used for 'INTERMEDIARY' paymentType
name	requestForPayment.payerDetails.name	string	name of the payer to whom the RFP is being sent
accountNumber	requestForPayment.payerDetails.accountNumber	string	Account number of the payer
routingNumber	requestForPayment.payerDetails.routingNumber	string	routing number of the receiving bank
ultimatePayerDetails	requestForPayment.ultimatePayerDetails	UltimatePayer	Ultimate payer details incase payer is intermediary. Should only be used for 'INTERMEDIARY' paymentType
transactionID	requestForPayment.requestDetails.transactionID	string	Transaction id assigned by US Bank.
amount	requestForPayment.requestDetails.amount	number	Amount to be transferred. The amount should be formatted with 2 decimal places
paymentType	requestForPayment.requestDetails.paymentType	string	Type of RTP payment that will allow the sending and receiving bank to process the payment appropriately
requestedExecutionDateTime	requestForPayment.requestDetails.requestedExecutionDateTime	string	Date or Date & time on which the payment is to be executed. If only date is provided, then it is assumed that the payment is to be done by EOD calendar day, ET
expiryDateTime	requestForPayment.requestDetails.expiryDateTime	string	Date or date and time, after which, the debtor isn't allowed to initiate a CT in response to this request. Date cant be before execution date
paymentModificationAllowed	requestForPayment.requestDetails.paymentModificationAllowed	boolean	Indicates if an amount other than the requested amount can be paid or not
responseDetails	requestForPayment.responseDetails	RFPResponseDetails
remittanceID	requestForPayment.remittanceData.remittanceID	string	Remittance Identification from remt.001 to identify the separate remittance advice sent by the Debtor that is associated with the Credit Transfer
email	requestForPayment.remittanceData.remittanceLocationDetails.email	string	Email address where the remittance info was sent
URI	requestForPayment.remittanceData.remittanceLocationDetails.URI	string	URI where the remittance info was sent
additionalInfo	requestForPayment.remittanceData.additionalInfo	string	Used to provide additional remittance related information
fullAmount	requestForPayment.remittanceData.discountDetails.fullAmount	number	Amount before the discount is applied.This field is used to indicate total due amount for bill pay related RFPs
discountedAmount	requestForPayment.remittanceData.discountDetails.discountedAmount	number	Amount after the discount is applied.This field is used to indicate minimum due amount for bill pay related RFPs

RFPResponseDetails

Name	Path	Type	Description
responseCode	responseCode	string	Captures the type of response. Scheduled - RFP scheduled for a future date Reject - RFP will not be paid.
creditTransfertransactionIDs	creditTransfertransactionIDs	array of string	Transaction IDs of the credit transfer(s) in case any credit transfers were sent in response to RFP
rejectReason	rejectionDetails.rejectReason	string	Reject reason incase a rejection was sent by the receiver
additionalInformation	rejectionDetails.additionalInformation	string	Additional Information on the reject reason
amountAccepted	scheduledPaymentDetails.amountAccepted	number	Amount accepted if payment modification is allowed in original RFP
earlyPaymentIndicator	scheduledPaymentDetails.earlyPaymentIndicator	boolean	Indicates if the debtor agrees to pay on or before the requested date or not
scheduledDateTime	scheduledPaymentDetails.scheduledDateTime	YYYY-MM-DDThh:mm:ss	The date or date and time on which the payment is scheduled

RTPEligibilityResponse

Provides RTP eligibility information for a routing number

Name	Path	Type	Description
rtpEligible	rtpEligible	boolean	Indicates if the routing number provided is part of the RTP network

AccountDescriptor

Light weight summary of the account

Name	Path	Type	Description
accountID	accountID	string	Unique ID for the Account
accountName	accountName	string	Name of Account
accountNumber	accountNumber	string	Account Number of the authorized customer
routingNumber	routingNumber	string	Routing Number of the authorized customer
bankName	bankName	string	Name of the customers Bank
accountType	accountType	string	Type of Account
currency	currency	string	ISO currency code of the transaction or balance

PageMeta

To minimize response times for requests and generally improve the end-user experience

Name	Path	Type	Description
pageNumber	pageNumber	number	Current page number
pageSize	pageSize	number	Results per page
pageCount	pageCount	number	Total number of pages in the result set
totalCount	totalCount	number	Total number of result records
links	links	PageLinks	links

PageLinks

links

Name	Path	Type	Description
prev	prev	string	URL for previous page
next	next	string	URL for next page

Warnings

A warning entity which can be used at the API level for successful responses.

Name	Path	Type	Description
code	code	string	Long term persistent identifier which can be used to trace warning condition back to log information
message	message	string	End user displayable information, this is the human readable text that provides a high level categorization of the warning that has occurred
details	details	array of object
attributeName	details.attributeName	string
reason	details.reason	string

AccountSummaryCurrentDay

Account Details Extends and inherits all fields from AccountDescriptor.