美国银行财政部（预览版）
美国银行付款和财政部银行 API。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 联系人 | |
|---|---|
| Name | 美国银行 API 团队 |
| URL | https://developer.usbank.com/contact |
| apisupport@usbank.com |
| 连接器元数据 | |
|---|---|
| 发布者 | 美国银行 |
| Website | https://developer.usbank.com/ |
| 隐私策略 | https://developer.usbank.com/privacy |
| 类别 | 金融 |
美国银行提供了一套财政部管理 API，用于为组织创建灵活无缝的银行体验。 轻松将 ERP 和其他财政部应用程序连接到我们的公司帐户信息和 RTP® - Real-Time 付款服务。 通过结算所 RTP® 网络即时访问公司帐户、交易数据并启动和管理实时付款。
先决条件
- 美国银行开发人员门户上的帐户。
- 返回到美国银行 API 载入团队的已完成门户访问表单。
- 来自美国银行 API 载入团队的 API 凭据。
- 来自美国银行财政部管理实施团队的 SinglePoint 用户凭据。
如何获取凭据
注册以在我们的 开发人员门户中创建一个美国银行开发人员门户帐户。 通过引导你完成作的屏幕上说明可以轻松注册。 如果需要帮助，请与我们联系。
请与我们联系 以请求密钥。 在“ 联系我们 ”窗体上的“邮件”字段中输入以下消息。
“我想从Microsoft连接器访问此 API。
你将从apionboarding@usbank.com“完成门户访问表单”收到门户访问表单并将其返回到美国银行。apionboarding@usbank.com
在门户访问表单上的“描述企业如何使用美国银行 API 和/或相关数据”字段中输入以下文本：
“我想通过 Microsoft 连接器访问 API。
若要使用与公司帐户信息相关的作，必须请求访问公司帐户信息服务。 若要使用与 RTP® 相关的作 - Real-Time 付款，必须请求访问 RTP® - Real-Time 付款服务。
美国银行 API 载入团队将向组织分配一名美国银行财务管理顾问。 美国银行财政部管理顾问或美国银行 API 载入团队将与你联系，讨论后续步骤。
确认要在发现调用中将连接器用于美国银行 API 载入团队和美国银行财政部销售团队。
一旦确认，美国银行将启动实施过程。 API 载入团队会将 API 凭据发送给你。 美国银行财政部管理实施协调员会将你的 SinglePoint 凭据发送给组织的 SinglePoint 管理员。
现已准备好使用连接器。
连接器入门
公司帐户信息功能
- 检索公司存款帐户的列表。
- 收集当天和前一天的详细帐户余额，收集功能一次最多 50 个帐户。 余额信息包括可用余额、账本余额和前一天和当前日期收集的余额。
- 接收当天和前一天帐户的事务数据。 历史事务最多可以 60 天，另外保留期为 12 个月或 24 个月。
- 将存款帐户的账单保留长达 12 个月。
示例用例
协调即时事务
公司 A 公司通常花费无数小时来协调其各种美国银行存款账户中支付的付款与内部公司系统（例如 ERP）。 使用此 API，公司 A 可以直接将交易详细信息从美国银行提取到任何系统中，以自动执行对帐过程。 无需在线或从银行账单中查看交易。
改进现金定位
B公司希望尽可能最大化其现金流，并在必要时只基金账户。 通过使用公司帐户信息 API，他们可以通过将余额信息提取到公司系统（例如 ERP）中，并实时协调支付或接收，从而在美国银行存款账户中投影现金仓位。 如果预计帐户余额将透支，B 公司可以立即以透支金额为帐户提供资金。
在一个位置查看帐户余额
负责管理公司的现金和批准向员工、供应商和第三方支付所有主要付款的经理经常关心起草帐户，并希望确保在付款支付之前将帐户资本化。 使用公司帐户信息 API，经理可以直接从公司系统查看美国银行存款帐户余额，而无需登录到多个系统来查看不同帐户和银行的余额。
改进财政部报告
经理维护分析仪表板，该仪表板为公司提供重要的财务信息和见解。 经理希望了解存款帐户余额在销售周期和信用额度杠杆方面的波动方式。 公司帐户信息 API 可帮助经理拉取美国银行存款帐户余额，执行评估以前的交易数据以及预测财务支出所需的分析。
RTP 功能
- 每天发送传输 24 小时，每周 7 天，每年 365 天。
- 启动和管理发票的实时结算和结算。
示例用例
信用转移邮件
开发人员团队需要找到一个解决方案来帮助客户发送资金。 客户需要使用转移资金功能将财务帐户中的资金发送到联系人。 使用 RTP® API，你可以允许使用美国银行支票帐户的客户随时随地向联系人发送付款。
实时付款发票
你的客户端是一个方便手，在一周内与多个客户端合作。 邮件发票和等待付款通过是一个麻烦，因为时间和跟踪。 搜索解决方案时，可以找到一个软件包，其中包含立即使用 RTP® API 发送发票。 现在，客户可以花更少的时间跟踪发票，并花费更多时间满足其他业务或生活需求。
RFP 功能
- 启动和管理发票的实时结算和结算。
- 验证计费者的身份及其金融机构的注册。
- 向客户发送可配置的提醒，以增强实时支付体验。
- 启用将来或部分付款。
示例用例
链接帐单透明度
客户需要支付电费。 使用 RTP® 付款请求 API，实用工具公司的开发人员团队构建了“付款请求”选项，通知客户应付款。 客户可以轻松提交付款，并查看“付款请求”选项已完成/已收到。
为客户提供最即时的信息
一家中型公司的开发人员最近实现了 RTP® 付款 API 请求。 一位同事在公司应付账目中工作，他注意到了与供应商和合作伙伴合作时所做的差异。 他们现在可以通过“付款请求”实时接收发票付款请求，并且可以在数秒内立即提交付款，完成交易。
已知问题和限制
- 需要 OAuth MFA，我们的 API 载入团队将协调生成 SinglePoint 和 OAuth 注册
常见错误和补救措施
错误消息通常与身份验证问题相关，请验证帐户是否有权访问正在请求的银行帐户。 请与我们联系 ，与支持团队交谈并解决任何其他问题。
FAQ
谁可以使用美国银行 API 产品？
任何人都可以查看 API 产品的概述。 若要查看我们的技术文档并使用产品，需要创建帐户。
如何创建帐户？
通过 引导你完成作的屏幕上说明可以轻松注册。 如果需要帮助， 请与我们联系。
创建帐户后，登录以查看 API 产品文档。
如果我未收到帐户激活电子邮件，该怎么办？
检查电子邮件垃圾邮件文件夹。 如果找不到帐户激活电子邮件，请与我们联系。
如果我对 API 产品有技术问题，我应该联系谁？
每个 API 都有全面的技术文档，可帮助你完成 开发人员门户的介绍。 我们的支持团队还可以通过 支持表单为你提供任何问题或问题。
如何更改用户名或电子邮件地址？
提交 “联系我们” 表单，并告诉我们需要更改的内容。 包括用户名或电子邮件地址。 我们将向你发送电子邮件，其中包含后续步骤。
如果我忘记了密码，如何更新密码？
转到 “忘记密码” ，输入帐户的电子邮件地址。 我们将向你发送一个链接来更改它。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 启动 RTP 付款请求（RFP） |
允许应用程序启动 RTP 请求，以接收美国银行帐户中的资金。 |
| 启动 RTP 信用转移交易 |
允许应用程序启动 RTP 信用转移。 信用转移中的付款人应该是美国银行客户。 |
| 检查接收方的银行是否是 RTP 网络的一部分 |
检查收件人的银行是否是 RTP 网络的一部分。 需要接收银行的路由编号才能检查 RTP 资格。 |
| 检索发送的 RFP 的状态和详细信息 |
允许应用程序检索启动的 RTP RFP 的状态和详细信息。 |
| 检索发送的 RTP 信用额度转移事务的状态和详细信息 |
允许应用程序检索发起的 RTP 信用转移的状态和详细信息或传入的信用转移。 |
| 获取前一天帐户数组的帐户余额 |
获取前一天的帐户数组的帐户余额。 |
| 获取当前日期帐户数组的帐户余额 |
获取当前日期帐户数组的帐户余额。 |
| 获取当前日期帐户的交易 |
获取当前日期帐户的事务。 |
| 获取授权客户的帐户列表 |
获取授权客户的帐户列表。 |
| 获取日期范围内以前工作日的帐户交易 |
获取日期范围内以前工作日的帐户交易。 |
启动 RTP 付款请求（RFP）
允许应用程序启动 RTP 请求，以接收美国银行帐户中的资金。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Content-Type 标头
|
Content-Type | True | string |
指示资源的媒体类型。 |
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
clientRequestID
|
clientRequestID | True | string |
客户端应用程序为每个信用转移/RFP 定义的唯一标识符 |
|
姓名
|
name | True | string |
发件人名称 |
|
accountNumber
|
accountNumber | True | string |
发件人的帐户号 |
|
routingNumber
|
routingNumber | True | Routing number should pass the check digit validation |
美国银行路由号码 |
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
要向其发送 RFP 的付款人的名称 |
|
accountNumber
|
accountNumber | True | string |
付款人的帐户号 |
|
routingNumber
|
routingNumber | True | Routing number should pass the check digit validation |
接收银行的路由编号 |
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
量
|
amount | True | number |
要转移的金额。 应使用 2 个小数位数设置金额的格式 |
|
paymentType
|
paymentType | True | string |
允许发送和接收银行适当处理付款的 RTP 付款类型 |
|
requestedExecutionDateTime
|
requestedExecutionDateTime | True | YYYY-MM-DDThh:mm:ss |
要对其执行付款的日期或日期和时间。 应提供东部时间的日期和时间。 如果仅提供日期，则假定付款由 EOD 日历日、ET 完成 |
|
expiryDateTime
|
expiryDateTime | True | YYYY-MM-DDThh:mm:ss |
日期或日期和时间，之后，不允许债务方发起 CT 以响应此请求。 日期和时间应根据东部时间提供。 日期不能在执行日期之前 |
|
paymentModificationAllowed
|
paymentModificationAllowed | True | boolean |
指示请求金额以外的金额是否可以支付 |
|
remittanceID
|
remittanceID | string |
来自 remt.001 的汇款识别，以识别与信用转移相关的债务人发送的单独汇款建议 |
|
|
电子邮件
|
string |
发送汇款信息的电子邮件地址 |
||
|
URI
|
URI | string |
发送汇款信息的 URI |
|
|
附加信息
|
additionalInfo | string |
用于提供其他汇款相关信息 |
|
|
fullAmount
|
fullAmount | True | number |
应用折扣前的金额。此字段用于指示与帐单支付相关的 RFP 的总到期金额 |
|
discountedAmount
|
discountedAmount | True | number |
应用折扣后金额。此字段用于指示与帐单支付相关的 RFP 的最低到期金额 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
transactionID
|
clientDetails.transactionID | string |
美国银行分配的唯一标识符。 此 ID 可用于稍后检索事务 |
|
clientRequestID
|
clientDetails.clientRequestID | string |
客户端应用程序为每个信用转移/RFP 定义的唯一标识符 |
启动 RTP 信用转移交易
允许应用程序启动 RTP 信用转移。 信用转移中的付款人应该是美国银行客户。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Content-Type 标头
|
Content-Type | True | string |
指示资源的媒体类型。 |
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
clientRequestID
|
clientRequestID | True | string |
客户端应用程序为每个信用转移/RFP 定义的唯一标识符 |
|
姓名
|
name | True | string |
帐户将被借记的美国银行客户的姓名 |
|
accountNumber
|
accountNumber | True | string |
付款人的帐户号 |
|
routingNumber
|
routingNumber | True | Routing number should pass the check digit validation |
美国银行路由号码 |
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
将记入帐户的付款人的姓名 |
|
accountNumber
|
accountNumber | True | string |
付款人的帐户号 |
|
routingNumber
|
routingNumber | True | Routing number should pass the check digit validation |
接收银行的路由编号 |
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
姓名
|
name | True | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
|
addressLine1
|
addressLine1 | True | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
|
城市
|
city | True | string |
收件人的居民城市。 |
|
状态
|
state | True | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | True | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | True | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
|
量
|
amount | True | number |
要转移的金额。 应使用 2 个小数位数设置金额的格式 |
|
paymentType
|
paymentType | True | string |
允许发送和接收银行适当处理付款的 RTP 付款类型 |
|
remittanceID
|
remittanceID | string |
来自 remt.001 的汇款识别，以识别与信用转移相关的债务人发送的单独汇款建议 |
|
|
电子邮件
|
string |
发送汇款信息的电子邮件地址 |
||
|
URI
|
URI | string |
发送汇款信息的 URI |
|
|
附加信息
|
additionalInfo | string |
用于提供其他汇款相关信息 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
transactionID
|
clientDetails.transactionID | string |
美国银行分配的唯一标识符。 此 ID 可用于稍后检索事务 |
|
clientRequestID
|
clientDetails.clientRequestID | string |
客户端应用程序为每个信用转移/RFP 定义的唯一标识符 |
检查接收方的银行是否是 RTP 网络的一部分
检查收件人的银行是否是 RTP 网络的一部分。 需要接收银行的路由编号才能检查 RTP 资格。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
要验证的银行路由编号
|
routingNumber | True | string |
接收方银行的 9 位路由编号 |
返回
提供路由编号的 RTP 资格信息
检索发送的 RFP 的状态和详细信息
允许应用程序检索启动的 RTP RFP 的状态和详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
正在检索的事务 ID
|
transactionID | True | string |
与要检索的事务关联的事务 ID。 |
返回
- Body
- RFPDetails
检索发送的 RTP 信用额度转移事务的状态和详细信息
允许应用程序检索发起的 RTP 信用转移的状态和详细信息或传入的信用转移。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
正在检索的事务 ID
|
transactionID | True | string |
与要检索的事务关联的事务 ID。 |
返回
- Body
- TransactionResponse
获取前一天帐户数组的帐户余额
获取前一天的帐户数组的帐户余额。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Content-Type 标头
|
Content-Type | True | string |
指示资源的媒体类型。 |
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
accountID
|
accountID | array of string |
帐户唯一标识符 |
|
|
accountNumber
|
accountNumber | string |
已授权客户的帐户号 |
|
|
routingNumber
|
routingNumber | string |
已授权客户的路由编号 |
|
|
accountType 账户类型
|
accountType | string |
帐户类型 |
|
|
pageNumber
|
pageNumber | string |
要返回的查询结果的当前页码 |
|
|
pageSize
|
pageSize | string |
结果页大小 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
accountsSummaryPreviousDay
|
accountsSummaryPreviousDay | array of AccountSummaryPreviousDay | |
|
警告
|
warnings | array of Warnings | |
|
pageMeta
|
pageMeta | PageMeta |
最大程度地减少请求的响应时间，并普遍改善最终用户体验 |
获取当前日期帐户数组的帐户余额
获取当前日期帐户数组的帐户余额。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Content-Type 标头
|
Content-Type | True | string |
指示资源的媒体类型。 |
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
accountID
|
accountID | array of string |
帐户唯一标识符 |
|
|
accountNumber
|
accountNumber | string |
已授权客户的帐户号 |
|
|
routingNumber
|
routingNumber | string |
已授权客户的路由编号 |
|
|
accountType 账户类型
|
accountType | string |
帐户类型 |
|
|
pageNumber
|
pageNumber | string |
要返回的查询结果的当前页码 |
|
|
pageSize
|
pageSize | string |
结果页大小 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
accountsSummaryCurrentDay
|
accountsSummaryCurrentDay | array of AccountSummaryCurrentDay | |
|
警告
|
warnings | array of Warnings | |
|
pageMeta
|
pageMeta | PageMeta |
最大程度地减少请求的响应时间，并普遍改善最终用户体验 |
获取当前日期帐户的交易
获取当前日期帐户的事务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
账户 ID
|
accountID | True | string |
唯一帐户标识符 |
|
银行参考交易 ID
|
bankReferenceNumber | string |
唯一事务标识符 |
|
|
页码
|
pageNumber | string |
要返回的查询结果的当前页码 |
|
|
页面大小
|
pageSize | string |
结果页大小 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
事务
|
transactions | array of Transaction | |
|
lastRefreshedDateTime
|
lastRefreshedDateTime | lastRefreshedDateTime |
数据来自的 ISO 8601 日期格式。 |
|
pageMeta
|
pageMeta | PageMeta |
最大程度地减少请求的响应时间，并普遍改善最终用户体验 |
获取授权客户的帐户列表
获取授权客户的帐户列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
页码
|
pageNumber | string |
要返回的查询结果的当前页码 |
|
|
页面大小
|
pageSize | string |
结果页大小 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
accounts
|
accounts | array of AccountDescriptor | |
|
pageMeta
|
pageMeta | PageMeta |
最大程度地减少请求的响应时间，并普遍改善最终用户体验 |
获取日期范围内以前工作日的帐户交易
获取日期范围内以前工作日的帐户交易。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
接受标头
|
Accept | True | string |
application/json |
|
Accept-Encoding 标头
|
Accept-Encoding | True | string |
Accept-Encoding |
|
每个请求响应对的唯一标识符
|
Correlation-ID | True | GUID |
每个请求响应对的唯一标识符 |
|
此请求适用于美国银行客户 ID
|
On-Behalf-Of | string |
如果 API 请求由服务提供商代表客户提交，则美国银行客户 ID。 此字段是有条件的必需字段。 |
|
|
账户 ID
|
accountID | True | string |
唯一帐户标识符 |
|
开始日期
|
startDate | string |
检索事务的开始日期/时间。 ISO 8601。 |
|
|
结束日期
|
endDate | string |
用于检索事务的结束日期/时间。 ISO 8601。 |
|
|
页码
|
pageNumber | string |
要返回的查询结果的当前页码 |
|
|
页面大小
|
pageSize | string |
结果页大小 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
事务
|
transactions | array of Transaction | |
|
pageMeta
|
pageMeta | PageMeta |
最大程度地减少请求的响应时间，并普遍改善最终用户体验 |
定义
地址
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
addressLine1
|
addressLine1 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
地址行 2
|
addressLine2 | string |
收件人的主地址。 包括房屋编号、街道名称、公寓号等。 |
|
城市
|
city | string |
收件人的居民城市。 |
|
状态
|
state | ISO 3166-2:US |
收件人的居民州。 |
|
邮政编码
|
zipCode | ##### or #####-#### |
收件人的常驻邮政编码。 |
|
country
|
country | ISO 3166 CountryCode |
收件人的居民国家/地区。 仅允许的值为 US。 |
ClientDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
clientRequestID
|
clientRequestID | string |
客户端应用程序为每个信用转移/RFP 定义的唯一标识符 |
UltimatePayer
最终付款人详细信息是中间人。 应仅用于“中介”paymentType
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
姓名
|
name | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
address
|
address | Address |
UltimatePayee
最终付款人详细信息是中间人。 应仅用于“中介”paymentType
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
姓名
|
name | string |
最终付款人的名称 |
|
标识符
|
identifier | string |
最终付款人的标识符 |
|
address
|
address | Address |
TransactionResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
clientDetails
|
transactiondDetails.clientDetails | ClientDetails | |
|
transactionID
|
transactiondDetails.transactionID | string |
信用转移交易的交易 ID |
|
originalRFPTransactionID
|
transactiondDetails.originalRFPTransactionID | string |
原始 RFP 的交易 ID（如果信用转移是响应 RFP） |
|
transactionType
|
transactiondDetails.transactionType | string |
事务是入站事务还是出站事务 |
|
状态码
|
transactiondDetails.status.statusCode | string | |
|
消息
|
transactiondDetails.status.message | string |
事务状态的其他详细信息 |
|
量
|
transactiondDetails.amount | number |
事务量 |
|
姓名
|
transactiondDetails.payerDetails.name | string |
付款人的名称 |
|
accountNumber
|
transactiondDetails.payerDetails.accountNumber | string |
用于付款的 Payer 帐户号的最后 4 位数字。 |
|
address
|
transactiondDetails.payerDetails.address | Address | |
|
ultimatePayerDetails
|
transactiondDetails.ultimatePayerDetails | UltimatePayer |
最终付款人详细信息是中间人。 应仅用于“中介”paymentType |
|
姓名
|
transactiondDetails.payeeDetails.name | string |
被付款人的姓名 |
|
accountNumber
|
transactiondDetails.payeeDetails.accountNumber | string |
被付款人的帐户号的最后 4 位数字 |
|
routingNumber
|
transactiondDetails.payeeDetails.routingNumber | string |
付款人银行的路由编号 |
|
address
|
transactiondDetails.payeeDetails.address | Address | |
|
ultimatePayeeDetails
|
transactiondDetails.ultimatePayeeDetails | UltimatePayee |
最终付款人详细信息是中间人。 应仅用于“中介”paymentType |
|
remittanceID
|
transactiondDetails.remittanceData.remittanceID | string |
来自 remt.001 的汇款识别，以识别与信用转移相关的债务人发送的单独汇款建议 |
|
电子邮件
|
transactiondDetails.remittanceData.remittanceLocationDetails.email | string |
发送汇款信息的电子邮件地址 |
|
URI
|
transactiondDetails.remittanceData.remittanceLocationDetails.URI | string |
发送汇款信息的 URI |
|
附加信息
|
transactiondDetails.remittanceData.additionalInfo | string |
用于提供其他汇款相关信息 |
RFPDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
clientDetails
|
requestForPayment.clientDetails | ClientDetails | |
|
transactionType
|
requestForPayment.transactionType | string |
事务是入站事务还是出站事务 |
|
状态码
|
requestForPayment.status.statusCode | string | |
|
消息
|
requestForPayment.status.message | string |
事务的其他详细信息 |
|
姓名
|
requestForPayment.payeeDetails.name | string |
发件人名称 |
|
accountNumber
|
requestForPayment.payeeDetails.accountNumber | string |
发件人的帐户号 |
|
routingNumber
|
requestForPayment.payeeDetails.routingNumber | string |
发送银行的路由编号 |
|
ultimatePayeeDetails
|
requestForPayment.ultimatePayeeDetails | UltimatePayee |
最终付款人详细信息是中间人。 应仅用于“中介”paymentType |
|
姓名
|
requestForPayment.payerDetails.name | string |
要向其发送 RFP 的付款人的名称 |
|
accountNumber
|
requestForPayment.payerDetails.accountNumber | string |
付款人的帐户号 |
|
routingNumber
|
requestForPayment.payerDetails.routingNumber | string |
接收银行的路由编号 |
|
ultimatePayerDetails
|
requestForPayment.ultimatePayerDetails | UltimatePayer |
最终付款人详细信息是中间人。 应仅用于“中介”paymentType |
|
transactionID
|
requestForPayment.requestDetails.transactionID | string |
美国银行分配的事务 ID。 |
|
量
|
requestForPayment.requestDetails.amount | number |
要转移的金额。 应使用 2 个小数位数设置金额的格式 |
|
paymentType
|
requestForPayment.requestDetails.paymentType | string |
允许发送和接收银行适当处理付款的 RTP 付款类型 |
|
requestedExecutionDateTime
|
requestForPayment.requestDetails.requestedExecutionDateTime | string |
要对其执行付款的日期或日期和时间。 如果仅提供日期，则假定付款由 EOD 日历日、ET 完成 |
|
expiryDateTime
|
requestForPayment.requestDetails.expiryDateTime | string |
日期或日期和时间，之后，不允许债务方发起 CT 以响应此请求。 日期不能在执行日期之前 |
|
paymentModificationAllowed
|
requestForPayment.requestDetails.paymentModificationAllowed | boolean |
指示请求金额以外的金额是否可以支付 |
|
responseDetails
|
requestForPayment.responseDetails | RFPResponseDetails | |
|
remittanceID
|
requestForPayment.remittanceData.remittanceID | string |
来自 remt.001 的汇款识别，以识别与信用转移相关的债务人发送的单独汇款建议 |
|
电子邮件
|
requestForPayment.remittanceData.remittanceLocationDetails.email | string |
发送汇款信息的电子邮件地址 |
|
URI
|
requestForPayment.remittanceData.remittanceLocationDetails.URI | string |
发送汇款信息的 URI |
|
附加信息
|
requestForPayment.remittanceData.additionalInfo | string |
用于提供其他汇款相关信息 |
|
fullAmount
|
requestForPayment.remittanceData.discountDetails.fullAmount | number |
应用折扣前的金额。此字段用于指示与帐单支付相关的 RFP 的总到期金额 |
|
discountedAmount
|
requestForPayment.remittanceData.discountDetails.discountedAmount | number |
应用折扣后金额。此字段用于指示与帐单支付相关的 RFP 的最低到期金额 |
RFPResponseDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
responseCode
|
responseCode | string |
捕获响应的类型。 |
|
creditTransfertransactionIDs
|
creditTransfertransactionIDs | array of string |
在响应 RFP 时发送任何信用转移时，信用转移的交易 ID |
|
rejectReason
|
rejectionDetails.rejectReason | string |
接收方发送拒绝的拒绝原因 |
|
附加信息
|
rejectionDetails.additionalInformation | string |
有关拒绝原因的其他信息 |
|
amountAccepted
|
scheduledPaymentDetails.amountAccepted | number |
如果原始 RFP 中允许付款修改，则接受的金额 |
|
earlyPaymentIndicator
|
scheduledPaymentDetails.earlyPaymentIndicator | boolean |
指示债务人是否同意在请求日期或之前付款 |
|
scheduledDateTime
|
scheduledPaymentDetails.scheduledDateTime | YYYY-MM-DDThh:mm:ss |
计划付款的日期和时间 |
RTPEligibilityResponse
提供路由编号的 RTP 资格信息
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
rtpEligible
|
rtpEligible | boolean |
指示提供的路由号是否是 RTP 网络的一部分 |
AccountDescriptor
帐户的轻量摘要
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
accountID
|
accountID | string |
帐户的唯一 ID |
|
账户名称
|
accountName | string |
帐户名称 |
|
accountNumber
|
accountNumber | string |
已授权客户的帐户号 |
|
routingNumber
|
routingNumber | string |
已授权客户的路由编号 |
|
bankName
|
bankName | string |
客户银行的名称 |
|
accountType 账户类型
|
accountType | string |
帐户类型 |
|
货币
|
currency | string |
交易或余额的 ISO 货币代码 |
PageMeta
最大程度地减少请求的响应时间，并普遍改善最终用户体验
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
pageNumber
|
pageNumber | number |
当前页码 |
|
pageSize
|
pageSize | number |
每页结果数 |
|
pageCount
|
pageCount | number |
结果集中的页总数 |
|
totalCount
|
totalCount | number |
结果记录总数 |
|
链接
|
links | PageLinks |
链接 |
PageLinks
链接
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
昨日
|
prev | string |
上一页的 URL |
|
下一个
|
next | string |
下一页的 URL |
Warnings
可在 API 级别用于成功响应的警告实体。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string |
长期持久标识符，可用于将警告条件跟踪回日志信息 |
|
消息
|
message | string |
最终用户可显示的信息，这是人类可读文本，提供已发生的警告的高级分类 |
|
详情
|
details | array of object | |
|
属性名称
|
details.attributeName | string | |
|
原因
|
details.reason | string |
AccountSummaryCurrentDay
AccountSummaryPreviousDay
支票
以下对象中字段的可用性取决于事务的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
captureDate
|
captureDate | date |
检查的捕获日期 |
lastRefreshedDateTime
ACH
以下对象中字段的可用性取决于事务的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
companyName
|
companyName | string |
公司名称 |
|
individualID
|
individualID | string |
单个 ID |
|
companyID
|
companyID | string |
公司 ID |
|
secCode
|
secCode | string |
SEC 代码 |
|
companyDiscretionaryData
|
companyDiscretionaryData | string |
公司自由裁量数据 |
|
entryDescription
|
entryDescription | string |
条目的说明 |
|
effectiveEntryDate
|
effectiveEntryDate | date |
事务的有效输入日期 |
RTP
以下对象中字段的可用性取决于事务的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
已创建
|
created | date |
事务创建日期 |
|
debtorClientReference
|
debtorClientReference | string |
债务客户参考编号 |
|
debtorBankReference
|
debtorBankReference | string |
债务银行参考编号 |
|
debtorName
|
debtorName | string |
债务国名称 |
|
debtorAccount
|
debtorAccount | string |
债务账户 |
|
hierarchyBankID
|
debtorBankID | string |
债务银行标识符 |
|
借款银行
|
debtorBank | string |
债务银行 |
|
debtorAddress
|
debtorAddress | string |
债务人地址 |
|
creditorName
|
creditorName | string |
债权人名称 |
|
creditorAccount
|
creditorAccount | string |
债权人帐户 |
|
creditorBankID
|
creditorBankID | string |
债权人银行标识符 |
|
creditorBank
|
creditorBank | string |
债权人银行 |
|
creditorAddress
|
creditorAddress | string |
债权人地址 |
Zelle
以下对象中字段的可用性取决于事务的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
receiverName
|
receiverName | string |
接收方名称 |
|
别名
|
alias | string |
别名 |
|
paymentType
|
paymentType | string |
付款类型 |
|
生效日期
|
effectiveDate | date |
生效日期 |
|
paymentInstructionID
|
paymentInstructionID | string |
paymentInstructionID |
|
参数名称
|
parameterName | string |
参数名称 |
|
参数值
|
parameterValue | string |
参数值 |
电线
以下对象中字段的可用性取决于事务的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
parNumber
|
parNumber | string |
PAR 编号 |
|
源
|
source | string |
来源 |
|
repeatCode
|
repeatCode | string |
重复代码 |
|
鼻祖
|
originator | string |
发起方信息 |
|
originatorBank
|
originatorBank | string |
发起人银行名称 |
|
beneficiaryReference
|
beneficiaryReference | string |
受益者参考 |
|
受益人
|
beneficiary | string |
受益人 |
|
beneficiaryBank
|
beneficiaryBank | string |
受益银行名称 |
|
originatorToBeneficiaryInfo
|
originatorToBeneficiaryInfo | string |
发起人到受益者信息 |
|
sendingBank
|
sendingBank | string |
发件人银行名称 |
|
中介银行
|
intermediaryBank | string |
中介银行名称 |
|
receivingBank
|
receivingBank | string |
接收银行名称 |
|
receivedDate
|
receivedDate | date |
接收的日期/时间 |
|
completedDate
|
completedDate | date |
日期/时间已完成 |
|
发起者
|
initiatedBy | string |
启动传输的实体 |
|
approvedBy
|
approvedBy | string |
批准转让的实体 |
|
bankToBankInfo
|
bankToBankInfo | string |
银行到银行转帐信息 |
|
imad
|
imad | string |
IMAD 数字 |
|
fedReference
|
fedReference | string |
联邦参考编号 |
|
controlNumber
|
controlNumber | string |
控制编号 |
交易
帐户的基本信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
accountID
|
accountID | string |
帐户的唯一 ID |
|
transactionDate
|
transactionDate | string |
事务的发布日期 |
|
debitCreditIndicator
|
debitCreditIndicator | string |
借记/信用指示器 |
|
transactionDescription
|
transactionDescription | string |
事务说明 |
|
transactionType
|
transactionType | string |
事务类型 |
|
BAICode
|
BAICode | string |
银行管理研究所交易代码 |
|
transactionReferenceNumber
|
transactionReferenceNumber | string |
此属性是每个事务的客户提供的 ID。 它可能或可能不会回显，具体取决于客户提供还是由我们的系统映射。 |
|
bankReferenceNumber
|
bankReferenceNumber | string |
此属性是为每个事务生成的唯一事务 ID 的银行系统。 它指的是以下类型的事务 |
|
量
|
amount | number |
事务金额 |
|
货币
|
currency | string |
交易或余额的 ISO 货币代码 |
|
achTransactionDetails
|
achTransactionDetails | ACH |
以下对象中字段的可用性取决于事务的类型。 |
|
rtpTransactionDetails
|
rtpTransactionDetails | RTP |
以下对象中字段的可用性取决于事务的类型。 |
|
zelleTransactionDetails
|
zelleTransactionDetails | Zelle |
以下对象中字段的可用性取决于事务的类型。 |
|
checksTransactionDetails
|
checksTransactionDetails | Checks |
以下对象中字段的可用性取决于事务的类型。 |
|
wiresTransactionDetails
|
wiresTransactionDetails | Wires |
以下对象中字段的可用性取决于事务的类型。 |
|
附加信息
|
additionalInformation | array of string |