次の方法で共有

US バンクの財務管理 (プレビュー)

  • リファレンス

米国の銀行支払いと財務銀行業務の API です。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 US バンク API チーム
[URL] https://developer.usbank.com/contact
メール apisupport@usbank.com
Connector Metadata
発行者 US バンク
Web サイト https://developer.usbank.com/
プライバシー ポリシー https://developer.usbank.com/privacy
カテゴリー Finance

US バンクは、組織に柔軟でシームレスなバンキング エクスペリエンスを生み出すための一連の財務管理 API を提供しています。 ERP やその他の財務管理 アプリケーションを、企業口座情報や RTP® - リアルタイム支払いサービスに簡単に接続できます。 The Clearing House RTP® ネットワークを通じて、企業アカウント、取引データに即座にアクセスし、リアルタイム支払いを開始および管理します。

前提条件

  • US バンク開発者ポータルのアカウント。
  • US バンク API オンボーディング チームに返送される、記入済みのポータル アクセス フォーム。
  • US バンク API オンボーディング チームからの API 認証情報。
  • US バンク 財務管理導入チームからの SinglePoint ユーザー資格情報。

資格情報の入手方法

  1. 開発者ポータルでサインアップして、US バンクの開発者ポータル アカウントを作成してください。 サインアップは、画面上の指示に従って簡単に行えます。 ご不明な点はお問い合わせください。

  2. キーのリクエストにつきましては、お問い合わせください。 お問い合わせ フォームの「メッセージ」フィールドに以下のメッセージを入力してください。

    「Microsoft コネクタからこの API へのアクセスを希望します。」

  3. apionboarding@usbank.com からポータルへのアクセス フォームが送信されます。ポータル アクセス フォームにご記入の上、US バンクまでご返送ください (apionboarding@usbank.com)。

  4. ポータルアクセスフォームの 「US バンクの API や関連データを利用する方法と理由を説明してください」 フィールドに以下のテキストを入力してください:

    「Microsoft コネクタ経由で API へのアクセスを希望します。」

    企業アカウント情報に関連するアクションを使用するには、企業アカウント情報サービスへのアクセスをリクエストする必要があります。 リアルタイム ペイメント ( RTP®) に関連するアクションを使用するには、RTP® - リアルタイム ペイメント サービスへのアクセスを申請する必要があります。

  5. 米国銀行 API オンボーディング チームは、US バンク財務管理コンサルタントを組織に割り当てます。 US バンク財務管理コンサルタントまたはUS バンク API オンボーディング チームから、次のステップについて確認のご連絡をいたします。

  6. US バンク API オンボーディング チームおよび US バンク財務セールス チームとのディスカバリー コールでコネクタを使用することを確認します。

  7. 確認が完了すると、US バンクは実装プロセスを開始します。 API オンボーディング チームが API 認証情報を送信します。 US バンク財務管理実装コーディネーターが、SinglePoint 資格情報を組織の SinglePoint 管理者 に送信します。

  8. 以上で、コネクタを使用する準備ができました。

コネクタの使用を開始する

法人口座情報の機能

  • 会社の預金口座のリストを取得します。
  • 当日と前日の詳細な口座残高を収集します。一度に最大50口座の収集が可能です。 残高情報には、利用可能な残高、元帳残高、および前日と当日の収集残高が含まれます。
  • 口座の取引データを当日および前日ベースで受信します。 過去のトランザクションは最大 60 日間利用でき、オプションで 12 か月または 24 か月の追加保存期間を選択できます。
  • 預金口座の明細書は最長 12 か月間保管します。

使用事例

インスタント トランザクションを調整する

A 社は、米国のさまざまな銀行預金口座で行われた、または受け取った支払いを社内システム (ERP など) と照合するために数え切れないほどの時間を費やしています。 この API を使用すると、A 社は取引詳細を US バンクから直接任意のシステムに即座に取り込み、調整プロセスを自動化できます。 オンラインや銀行取引明細書から取引を確認する必要はありません。

キャッシュ ポジションの改善

企業 B は、キャッシュ フローを最大化し、必要な場合にのみ口座に資金を提供したいと考えています。 企業口座情報 API を使用することで、企業システム (ERP など) に残高情報を取り込み、リアルタイムで入出金の照合を行うことで、US バンクの預金口座のキャッシュポジションを予測することができる。 口座残高が当座貸越になると予測される場合、企業 B は当座貸越の金額を直ちに口座に入金できます。

口座残高を 1 か所で表示する

会社の現金を管理し、従業員、ベンダー、サードパーティへのすべての主要な支払いを承認する責任を負う管理者は、口座の起草を懸念していることが多く、支払いの支払い前に口座が資本化されていることを確認したいと考えています。 企業口座情報 API を使用すると、管理者は異なる口座や銀行間の残高を表示するために複数のシステムにログインすることなく、会社のシステムから直接 US バンクの預金口座残高を表示することができます。

財務報告の改善

管理者は、会社の重要な財務情報と分析情報を提供する分析ダッシュボードを管理します。 管理者は、販売サイクルとクレジット ラインのレバレッジに関連して、預金口座の残高が時間とともにどのように変動するかを理解したいと考えています。 法人口座情報 API は、管理者が US バンクの預金口座残高を引き出し、過去の取引データを評価し、財務支出を予測するために必要な分析を実行するのに役立ちます。

RTP 機能

  • 1 日 24 時間、年中無休で送金できます。
  • 請求書のリアルタイムの清算と決済を開始および管理します。

使用事例

口座振替メッセージ

開発者のチームは、顧客の送金を支援するソリューションを見つける必要があります。 顧客は、送金機能を使用して金融口座から連絡先に送金する必要があります。 RTP® API を使用すると、US バンクの当座預金口座を持つ顧客がいつでもどこでも連絡先に送金できるようになります。

リアルタイム支払いの作成

あなたのクライアントは便利屋で、週を通して複数のクライアントと仕事をしています。 請求書を郵送し、入金を待つのは、時間と追跡が必要で手間がかかります。 ソリューションを探していると、RTP® API を使用して請求書を即時に送信する機能を含むソフトウェア パッケージを見つけました。 これで、クライアントは請求書の追跡にかかる時間を短縮し、他のビジネスや生活上のニーズにより多くの時間を費やすことができます。

RFP 機能

  • 請求書のリアルタイムの清算と決済を開始および管理します。
  • 請求者の身元と金融機関への登録を確認します。
  • 設定可能なリマインダーを顧客に送信して、リアルタイムの支払いエクスペリエンスを強化します。
  • 将来の支払いまたは部分的な支払いを有効にします。

使用事例

請求書のリンクの透明性

顧客は電気料金を支払う必要があります。 RTP® 支払い要求 API を使用して、電力会社の開発チームは、公共料金の支払い期日を顧客に通知する支払い要求オプションを作成します。 顧客は簡単に支払いを送信し、支払いリクエストのオプションが完了/受理されたことを確認できます。

顧客に最新の情報を提供する

中堅企業の開発者は最近、支払い請求 (RTP®) API を実装しました。 会社の買掛金担当の同僚は、ベンダーやパートナーと協力することで生じる違いに気づいています。 支払い請求を通じてリアルタイムで請求書の支払いリクエストを受信し、即座に支払いを送信して数秒以内に取引を完了できるようになりました。

既知の問題と制限事項

  • OAuth MFA が必要となります。API オンボーディング チームが SinglePoint および OAuth 登録の生成を調整します

一般的なエラーと解決策

エラー メッセージは通常、認証の問題に関連するものです。顧客の口座が、請求対象の銀行口座にアクセスできることをご確認ください。 お問い合わせ サポート チームに相談し、その他の問題を解決してください。

よくあるご質問

US バンクの API 製品を使用できるのは対象者は誰ですか？

誰でも API 製品の概要を閲覧できます。 技術文書を参照し、製品を使用するには、アカウントを作成する必要があります。

アカウントを作成する方法

サインアップ は、画面上の指示に従って簡単に行えます。 ご不明な点は お問い合わせください。

アカウントを作成したら、ログインして API 製品ドキュメントを表示します。

アカウント アクティベーション メールを受け取っていない場合はどうすればよいですか?

迷惑メールフォルダーを確認してください。 アカウントのアクティベーション メールが見つからない場合は、お問い合わせ ください。

API 製品に関する技術的な質問がある場合、どこに問い合わせればよいですか?

各 API には包括的な技術文書が用意されており、開発者ポータルサイト でご利用いただけます。 また、サポート チームでは、サポート フォーム を通じて、ご質問や問題の解決をお手伝いいたします。

ユーザー名またはメールアドレスを変更するにはどうすればよいですか?

問い合わせ フォームに必要事項をご記入の上、ご送信ください。 ユーザー名またはメールアドレスを含めてください。 次の手順を記載したメールをお送りします。

パスワードを忘れた場合、どうすれば更新できますか?

パスワードを忘れた場合 に移動し、アカウントの電子メール アドレスを入力します。 変更のリンクをお送りします。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

RTP クレジット転送のステータスと詳細を取得する 送信されたトランザクション

アプリケーションは、開始された RTP 単位の移行または受信単位移行のステータスと詳細を検索できます。
RTP クレジット転送トランザクションを開始する

アプリケーションが RTP クレジット転送を開始できるようにします。 クレジット転送の支払人は US バンクの顧客である必要があります。
RTP 支払い要求 (RFP) を開始します

アプリケーションが US バンクの口座でお金を受け取るための支払いの RTP リクエストを開始できるようにします。
前日の一連の口座残高を取得します

前日の一連の口座残高を取得します。
受取人の銀行が RTP ネットワークの一部であるかどうかを確認します

受取人の銀行が RTP ネットワークの一部であるかどうかを確認します RTP の適格性を確認するには、受取銀行のルーティング番号が必要です。
当日の一連の口座残高を取得する

当日の一連の口座残高を取得します。
当日の口座取引を取得する

当日の口座取引を取得します。
承認された顧客のアカウントのリストを取得する

承認された顧客のアカウントのリストを取得します。
日付範囲にわたる前営業日のアカウントのトランザクションを取得する

日付範囲にわたる前営業日のアカウントのトランザクションを取得します。
送信された RFP のステータスと詳細を取得する

アプリケーションが、開始された RTP RFP のステータスと詳細を取得できるようにします。

RTP クレジット転送のステータスと詳細を取得する 送信されたトランザクション

操作 ID:
GetRTPCreditTransfer

アプリケーションは、開始された RTP 単位の移行または受信単位移行のステータスと詳細を検索できます。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
検索されるトランザクション ID
 transactionID True string

取得されるトランザクションに関連付けられたトランザクション ID です。

戻り値

Body
TransactionResponse

RTP クレジット転送トランザクションを開始する

操作 ID:
InitiateRTPCreditTransfer

アプリケーションが RTP クレジット転送を開始できるようにします。 クレジット転送の支払人は US バンクの顧客である必要があります。

パラメーター

名前 キー 必須 型 説明
Content-Type ヘッダー
 Content-Type True string

リソースのメディア タイプを示します。
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
clientRequestID
 clientRequestID True string

すべてのクレジット転送/ RFP に対してクライアント アプリケーションによって定義される一意の識別子
名称
 name True string

口座から引き落とされる US バンクの顧客の名前
accountNumber
 accountNumber True string

支払人の口座番号
routingNumber
 routingNumber True Routing number should pass the check digit validation

US バンクのルーティング番号
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
名称
 name True string

最終支払者名
識別子
 identifier string

最終支払者の識別子
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 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

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
名称
 name True string

最終受取人の氏名
識別子
 identifier string

最終受取人の識別子
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
amount
 amount True number

送金額です。 金額は小数点以下 2 桁でフォーマットする必要があります
paymentType
 paymentType True string

送金銀行と受取銀行が支払いを適切に処理できるようにする RTP 支払いのタイプ
remittanceID
 remittanceID string

remt.001 から、クレジット譲渡に関連する債務者から送付された個別の送金ア ドバイスを識別するための送金識別情報です
メールアドレス
 email string

送金情報が送信されたメールアドレス
URI
 URI string

送金情報が送信された URI
additionalInfo
 additionalInfo string

追加の送金関連情報を提供するために使用されます

戻り値

名前 パス 型 説明
transactionID
 clientDetails.transactionID string

US バンクによって割り当てられた一意の識別子です。 この ID は、後でトランザクションの検索に使用することができます
clientRequestID
 clientDetails.clientRequestID string

すべてのクレジット転送/ RFP に対してクライアント アプリケーションによって定義される一意の識別子

RTP 支払い要求 (RFP) を開始します

操作 ID:
InitiateRFP

アプリケーションが US バンクの口座でお金を受け取るための支払いの RTP リクエストを開始できるようにします。

パラメーター

名前 キー 必須 型 説明
Content-Type ヘッダー
 Content-Type True string

リソースのメディア タイプを示します。
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 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

US バンクのルーティング番号
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
名称
 name True string

最終受取人の氏名
識別子
 identifier string

最終受取人の識別子
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 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

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
名称
 name True string

最終支払者名
識別子
 identifier string

最終支払者の識別子
addressLine1
 addressLine1 True string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city True string

受取人の居住都市です。
州
 state True ISO 3166-2:US

受取人の州です。
zipCode
 zipCode True ##### or #####-####

受取人の郵便番号です。
国
 country True ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。
amount
 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 から、クレジット譲渡に関連する債務者から送付された個別の送金ア ドバイスを識別するための送金識別情報です
メールアドレス
 email string

送金情報が送信されたメールアドレス
URI
 URI string

送金情報が送信された URI
additionalInfo
 additionalInfo string

追加の送金関連情報を提供するために使用されます
fullAmount
 fullAmount True number

割引適用前の金額です。このフィールドは、請求書払いに関連する RFP の支払期限総額を示すために使用されます
discountedAmount
 discountedAmount True number

割引適用後の金額です。このフィールドは、請求書払いに関連する RFP の支払期限の最小額を示すために使用されます

戻り値

名前 パス 型 説明
transactionID
 clientDetails.transactionID string

US バンクによって割り当てられた一意の識別子です。 この ID は、後でトランザクションの検索に使用することができます
clientRequestID
 clientDetails.clientRequestID string

すべてのクレジット転送/ RFP に対してクライアント アプリケーションによって定義される一意の識別子

前日の一連の口座残高を取得します

操作 ID:
GetAccountBalancesOfPreviousDay

前日の一連の口座残高を取得します。

パラメーター

名前 キー 必須 型 説明
Content-Type ヘッダー
 Content-Type True string

リソースのメディア タイプを示します。
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 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
 warnings array of Warnings
pageMeta
 pageMeta PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

受取人の銀行が RTP ネットワークの一部であるかどうかを確認します

操作 ID:
GetRTPEligibility

受取人の銀行が RTP ネットワークの一部であるかどうかを確認します RTP の適格性を確認するには、受取銀行のルーティング番号が必要です。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
検証する銀行のルーティング番号
 routingNumber True string

受取人の銀行の 9 桁のルーティング番号

戻り値

ルーティング番号の RTP 適格性情報を提供します

Body
RTPEligibilityResponse

当日の一連の口座残高を取得する

操作 ID:
GetAccountBalancesOfCurrentDay

当日の一連の口座残高を取得します。

パラメーター

名前 キー 必須 型 説明
Content-Type ヘッダー
 Content-Type True string

リソースのメディア タイプを示します。
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 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
 warnings array of Warnings
pageMeta
 pageMeta PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

当日の口座取引を取得する

操作 ID:
GetTransactionsOfCurrentDay

当日の口座取引を取得します。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
取引先企業 ID
 accountID True string

アカウントを表す一意識別子
銀行参照取引 ID
 bankReferenceNumber string

トランザクションの一意識別子
ぺージ番号
 pageNumber string

クエリ結果から現在のページ番号を返す
ページ サイズ
 pageSize string

結果ページのサイズ

戻り値

名前 パス 型 説明
transactions
 transactions array of Transaction
lastRefreshedDateTime
 lastRefreshedDateTime lastRefreshedDateTime

ISO 8601 データの日付形式です。
pageMeta
 pageMeta PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

承認された顧客のアカウントのリストを取得する

操作 ID:
GetAccountsList

承認された顧客のアカウントのリストを取得します。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
ぺージ番号
 pageNumber string

クエリ結果から現在のページ番号を返す
ページ サイズ
 pageSize string

結果ページのサイズ

戻り値

名前 パス 型 説明
accounts
 accounts array of AccountDescriptor
pageMeta
 pageMeta PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

日付範囲にわたる前営業日のアカウントのトランザクションを取得する

操作 ID:
GetTransactionsOfPreviousDay

日付範囲にわたる前営業日のアカウントのトランザクションを取得します。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
取引先企業 ID
 accountID True string

アカウントを表す一意識別子
Start Date
 startDate string

トランザクションを取得する開始日時です。 ISO 8601。
終了日付
 endDate string

トランザクションを取得する終了日時です。 ISO 8601。
ぺージ番号
 pageNumber string

クエリ結果から現在のページ番号を返す
ページ サイズ
 pageSize string

結果ページのサイズ

戻り値

名前 パス 型 説明
transactions
 transactions array of Transaction
pageMeta
 pageMeta PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

送信された RFP のステータスと詳細を取得する

操作 ID:
GetRFP

アプリケーションが、開始された RTP RFP のステータスと詳細を取得できるようにします。

パラメーター

名前 キー 必須 型 説明
ヘッダーの承諾
 Accept True string

application/json
エンコードの承諾ヘッダー
 Accept-Encoding True string

エンコードの承諾
各リクエスト応答ペアの一意識別子
 Correlation-ID True GUID

各リクエスト応答ペアの一意識別子
このリクエストの対象となる米国銀行の顧客 ID
 On-Behalf-Of string

API リクエストが顧客に代わってサービス プロバイダーによって送信された場合の米国銀行の顧客 ID。 このフィールドは条件付きで必須です。
検索されるトランザクション ID
 transactionID True string

取得されるトランザクションに関連付けられたトランザクション ID です。

戻り値

Body
RFPDetails

定義

番地

名前 パス 型 説明
addressLine1
 addressLine1 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
addressLine2
 addressLine2 string

受信者のメインのメール アドレスです。 家番号、通り名、アパート番号などを含めます。
市
 city string

受取人の居住都市です。
州
 state ISO 3166-2:US

受取人の州です。
zipCode
 zipCode ##### or #####-####

受取人の郵便番号です。
国
 country ISO 3166 CountryCode

受取人の居住国です。 許容される値は US です。

ClientDetails

名前 パス 型 説明
clientRequestID
 clientRequestID string

すべてのクレジット転送/ RFP に対してクライアント アプリケーションによって定義される一意の識別子

UltimatePayer

支払人が仲介業者である場合の最終支払人の詳細です。 paymentType: INTERMEDIARY にのみ使用する必要があります

名前 パス 型 説明
名称
 name string

最終支払者名
識別子
 identifier string

最終支払者の識別子
address
 address Address

UltimatePayee

受取人が仲介業者である場合の最終受取人の詳細です。 paymentType: INTERMEDIARY にのみ使用する必要があります

名前 パス 型 説明
名称
 name string

最終受取人の氏名
識別子
 identifier string

最終受取人の識別子
address
 address Address

TransactionResponse

名前 パス 型 説明
clientDetails
 transactiondDetails.clientDetails ClientDetails
transactionID
 transactiondDetails.transactionID string

クレジット振替取引のトランザクション ID
originalRFPTransactionID
 transactiondDetails.originalRFPTransactionID string

クレジット転送が RFP に応じて行われる場合の、元の RFP のトランザクション ID
transactionType
 transactiondDetails.transactionType string

トランザクションがインバウンド トランザクションであるかアウトバウンド トランザクションであるか
状態Code
 transactiondDetails.status.statusCode string
message
 transactiondDetails.status.message string

トランザクション状況の詳細
amount
 transactiondDetails.amount number

トランザクション金額
名称
 transactiondDetails.payerDetails.name string

支払者の名前
accountNumber
 transactiondDetails.payerDetails.accountNumber string

支払いに使用された支払者の口座番号の下 4 桁です。
address
 transactiondDetails.payerDetails.address Address
ultimatePayerDetails
 transactiondDetails.ultimatePayerDetails UltimatePayer

支払人が仲介業者である場合の最終支払人の詳細です。 paymentType: INTERMEDIARY にのみ使用する必要があります
名称
 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: INTERMEDIARY にのみ使用する必要があります
remittanceID
 transactiondDetails.remittanceData.remittanceID string

remt.001 から、クレジット譲渡に関連する債務者から送付された個別の送金ア ドバイスを識別するための送金識別情報です
メールアドレス
 transactiondDetails.remittanceData.remittanceLocationDetails.email string

送金情報が送信されたメールアドレス
URI
 transactiondDetails.remittanceData.remittanceLocationDetails.URI string

送金情報が送信された URI
additionalInfo
 transactiondDetails.remittanceData.additionalInfo string

追加の送金関連情報を提供するために使用されます

RFPDetails

名前 パス 型 説明
clientDetails
 requestForPayment.clientDetails ClientDetails
transactionType
 requestForPayment.transactionType string

トランザクションがインバウンド トランザクションであるかアウトバウンド トランザクションであるか
状態Code
 requestForPayment.status.statusCode string
message
 requestForPayment.status.message string

トランザクションのその他詳細
名称
 requestForPayment.payeeDetails.name string

送信者の名前
accountNumber
 requestForPayment.payeeDetails.accountNumber string

送信者の口座番号
routingNumber
 requestForPayment.payeeDetails.routingNumber string

送金銀行のルーティング番号
ultimatePayeeDetails
 requestForPayment.ultimatePayeeDetails UltimatePayee

受取人が仲介業者である場合の最終受取人の詳細です。 paymentType: INTERMEDIARY にのみ使用する必要があります
名称
 requestForPayment.payerDetails.name string

RFP の送付先の支払人名
accountNumber
 requestForPayment.payerDetails.accountNumber string

支払人の口座番号
routingNumber
 requestForPayment.payerDetails.routingNumber string

受取銀行のルーティング番号
ultimatePayerDetails
 requestForPayment.ultimatePayerDetails UltimatePayer

支払人が仲介業者である場合の最終支払人の詳細です。 paymentType: INTERMEDIARY にのみ使用する必要があります
transactionID
 requestForPayment.requestDetails.transactionID string

US バンクによって割り当てられたトランザクション ID です。
amount
 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
additionalInfo
 requestForPayment.remittanceData.additionalInfo string

追加の送金関連情報を提供するために使用されます
fullAmount
 requestForPayment.remittanceData.discountDetails.fullAmount number

割引適用前の金額です。このフィールドは、請求書払いに関連する RFP の支払期限総額を示すために使用されます
discountedAmount
 requestForPayment.remittanceData.discountDetails.discountedAmount number

割引適用後の金額です。このフィールドは、請求書払いに関連する RFP の支払期限の最小額を示すために使用されます

RFPResponseDetails

名前 パス 型 説明
responseCode
 responseCode string

応答のタイプを取得します。
予定済み - RFP は将来の日付に予定されています
拒否 - RFP は支払われません。
creditTransfertransactionIDs
 creditTransfertransactionIDs array of string

RFP に応じてクレジット転送が送信された場合のクレジット転送のトランザクション ID
rejectReason
 rejectionDetails.rejectReason string

受信者によって拒否が送信された場合の拒否理由
additionalInformation
 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
 accountName string

アカウント名
accountNumber
 accountNumber string

承認された顧客の口座番号
routingNumber
 routingNumber string

承認された顧客のルーティング番号
bankName
 bankName string

顧客の銀行名
accountType
 accountType string

アカウントの種類
通過
 currency string

取引または残高の ISO 通貨コード

PageMeta

リクエストに対するレスポンスタイムを最小限に抑え、エンドユーザー エクスペリエンスを全般的に向上させる

名前 パス 型 説明
pageNumber
 pageNumber number

現在のページの番号
pageSize
 pageSize number

1 ページに表示する結果の数
pageCount
 pageCount number

結果セット内のページの合計数
totalCount
 totalCount number

結果レコードの合計件数
links
 links PageLinks

links

links

名前 パス 型 説明
prev
 prev string

前のページの URL
次
 next string

次ページの URL

警告

成功した応答に対して API レベルで使用できる警告エンティティです。

名前 パス 型 説明
code
 code string

警告の状態をログ情報まで遡るために使用できる長期持続識別子
message
 message string

エンドユーザーが表示できる情報。これは、発生した警告を高レベルで分類した人間が読めるテキストです
details
 details array of object
attributeName
 details.attributeName string
reason
 details.reason string

AccountSummaryCurrentDay

アカウントの詳細はすべてのフィールドを AccountDescriptor から継承します。

アカウントの詳細はすべてのフィールドを AccountDescriptor から継承します。

AccountSummaryPreviousDay

アカウントの詳細はすべてのフィールドを AccountDescriptor から継承します。

アカウントの詳細はすべてのフィールドを AccountDescriptor から継承します。

チェック

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。

名前 パス 型 説明
captureDate
 captureDate date

小切手の取得日

lastRefreshedDateTime

ISO 8601 データの日付形式です。

ISO 8601 データの日付形式です。

string

ACH

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。

名前 パス 型 説明
companyName
 companyName string

Company Name
individualID
 individualID string

個人 ID
companyID
 companyID string

企業 ID
secCode
 secCode string

SEC コード
companyDiscretionaryData
 companyDiscretionaryData string

企業の裁量データ
entryDescription
 entryDescription string

エントリーの説明
effectiveEntryDate
 effectiveEntryDate date

トランザクションの有効入力日

RTP

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。

名前 パス 型 説明
created
 created date

トランザクション作成日
debtorClientReference
 debtorClientReference string

債務者クライアント参照番号
debtorBankReference
 debtorBankReference string

債務者の銀行参照番号
debtorName
 debtorName string

債務者名
debtorAccount
 debtorAccount string

債権者の口座
debtorBankID
 debtorBankID string

債務者の銀行の識別子
debtorBank
 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
 alias string

Alias
paymentType
 paymentType string

支払いタイプ
effectiveDate
 effectiveDate date

発行日
paymentInstructionID
 paymentInstructionID string

paymentInstructionID
parameterName
 parameterName string

パラメーター名
parameterValue
 parameterValue string

パラメーター値

ワイヤ

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。

名前 パス 型 説明
parNumber
 parNumber string

PAR 番号
source
 source string

Source
repeatCode
 repeatCode string

リピート コード
作成者
 originator string

発信者情報
originatorBank
 originatorBank string

発信者銀行名
beneficiaryReference
 beneficiaryReference string

受取人参照情報
受取人
 beneficiary string

受取人
beneficiaryBank
 beneficiaryBank string

受取銀行名
originatorToBeneficiaryInfo
 originatorToBeneficiaryInfo string

発信者から受益者までの情報
sendingBank
 sendingBank string

送信者の銀行名
intermediaryBank
 intermediaryBank string

仲介銀行名
receivingBank
 receivingBank string

受取銀行名
receivedDate
 receivedDate date

受取日時
completedDate
 completedDate date

完了日時
initiatedBy
 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 です。 以下の種類の取引を指します
1. RTP トランザクションの場合、bankReferenceNumber は一意のトランザクション ID である
2. BookTransfers 取引の場合、bankReferenceNumber は一意のトランザクション ID である
3. checkDeposits/CheckPaid/Cont Disb Checks/Outgoing の預金票の場合、bankReferenceNumber は一意のトランザクション ID である。
4. ACH トランザクションの場合、bankReferenceNumber は ACH ネットワークが提供する PAR 番号を指す
5. Zelle トランザクションの場合、bankReferenceNumber は paymentInstructionID を参照する
6. wire トランザクションの場合、bankReferenceNumber は fed/swift ネットワークが提供する PAR 番号を指す
amount
 amount number

トランザクション金額
通過
 currency string

取引または残高の ISO 通貨コード
achTransactionDetails
 achTransactionDetails ACH

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。
rtpTransactionDetails
 rtpTransactionDetails RTP

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。
zelleTransactionDetails
 zelleTransactionDetails Zelle

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。
checksTransactionDetails
 checksTransactionDetails Checks

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。
wiresTransactionDetails
 wiresTransactionDetails Wires

以下のオブジェクト内のフィールドが利用できるかどうかは、トランザクションのタイプによって異なります。
additionalInformation
 additionalInformation array of string