Udostępnij przez


Zarządzanie skarbem banku USA (wersja zapoznawcza)

Amerykańskie interfejsy API banków i banków skarbowych.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name US Bank API Team
adres URL https://developer.usbank.com/contact
Email apisupport@usbank.com
Metadane łącznika
Publisher Amerykański bank
Witryna internetowa https://developer.usbank.com/
Zasady ochrony prywatności https://developer.usbank.com/privacy
Kategorie Finance

Amerykański Bank oferuje zestaw interfejsów API zarządzania skarbami, które umożliwiają tworzenie elastycznych i bezproblemowych środowisk bankowych dla organizacji. Łatwe łączenie erp i innych aplikacji skarbowych z naszymi firmowymi informacjami o koncie i RTP® — Real-Time Usługi płatności. Natychmiast uzyskaj dostęp do kont firmowych, danych transakcji i zainicjuj płatności w czasie rzeczywistym za pośrednictwem sieci RTP® firmy Clearing House.

Wymagania wstępne

  • Konto w portalu deweloperów banku USA.
  • Ukończony formularz dostępu do portalu, który został zwrócony do zespołu dołączania interfejsu API banku USA.
  • Poświadczenia interfejsu API z zespołu dołączania interfejsu API banku USA.
  • Poświadczenia użytkownika programu SinglePoint z zespołu wdrożeniowego zarządzania skarbem banku USA.

Jak uzyskać poświadczenia

  1. Zarejestruj się, aby utworzyć konto portalu deweloperów banku USA w naszym portalu dla deweloperów. Rejestracja jest łatwa dzięki instrukcjom wyświetlanym na ekranie, które prowadzą Cię przez drogę. Jeśli potrzebujesz pomocy, skontaktuj się z nami.

  2. Skontaktuj się z nami , aby poprosić o klucze. Wprowadź poniższą wiadomość w polu "Wiadomość" w formularzu Skontaktuj się z nami .

    "Chcę uzyskać dostęp do tego interfejsu API z łącznika firmy Microsoft".

  3. Otrzymasz formularz dostępu do portalu z apionboarding@usbank.com sekcji Ukończ formularz dostępu do portalu i zwrócisz go do banku USA pod adresem apionboarding@usbank.com.

  4. Wprowadź następujący tekst w polu "Opisz, jak i dlaczego firma chce korzystać z interfejsów API banku USA i/lub powiązanych danych" w formularzu dostępu do portalu:

    "Chcę uzyskać dostęp do interfejsów API za pośrednictwem łącznika firmy Microsoft".

    Aby użyć akcji związanych z informacjami o koncie firmowym, musisz zażądać dostępu do usługi Informacji o koncie firmowym. Aby użyć akcji związanych z RTP — Real-Time Płatności, musisz zażądać dostępu do usługi RTP®® — Real-Time Płatności.

  5. Zespół dołączania interfejsu API banku USA przypisze do organizacji konsultanta ds. zarządzania skarbem banku USA. Konsultant ds. zarządzania skarbem banku USA lub zespół dołączania interfejsu API banku USA skontaktuje się z Tobą w celu omówienia następnych kroków.

  6. Potwierdź, że chcesz użyć łącznika w wywołaniu odnajdywania z zespołem dołączania interfejsu API banku USA i zespołem sprzedaży skarbu państwa USA.

  7. Po potwierdzeniu, Amerykański Bank rozpoczyna proces implementacji. Zespół dołączania interfejsu API wyśle do Ciebie swoje poświadczenia interfejsu API. Koordynator implementacji zarządzania skarbem banku USA wyśle poświadczenia singlePoint do administratora SinglePoint organizacji.

  8. Teraz możesz przystąpić do korzystania z łącznika.

Wprowadzenie do łącznika


Funkcje informacji o koncie firmowym

  • Pobieranie list kont depozytowych firmy.
  • Zbierz szczegółowe salda kont dla bieżącego dnia i poprzedniego dnia z możliwością zbierania maksymalnie 50 kont naraz. Informacje o saldzie obejmują dostępne saldo, saldo rejestru i zebrane salda dla poprzedniego i bieżącego dnia.
  • Odbieranie danych transakcji dla konta w bieżącym dniu i poprzednim dniu. Transakcje historyczne są dostępne do 60 dni z opcjami dodatkowego okresu przechowywania 12 lub 24 miesięcy.
  • Zachowaj wyciągi dla kont depozytowych przez maksymalnie 12 miesięcy.

Przykładowe przypadki użycia


Uzgadnianie transakcji błyskawicznych

Firma A często spędza niezliczone godziny uzgadniając płatności dokonane z lub otrzymane w różnych amerykańskich kontach depozytowych bankowych do systemów firmy wewnętrznej (np. ERP). Korzystając z tego interfejsu API, firma A może natychmiast ściągnąć szczegóły transakcji bezpośrednio z banku USA do dowolnego systemu w celu zautomatyzowania procesu uzgadniania. Nie trzeba przeglądać transakcji online ani z wyciągów bankowych.

Ulepszanie pozycjonowania gotówkowego

Firma B chce zmaksymalizować swoje przepływy pieniężne i tylko rachunki finansowe w razie potrzeby. Korzystając z interfejsu API informacji o koncie firmowym, mogą oni projektować pozycje gotówkowe na swoich kontach depozytowych banku USA, ściągając informacje o saldu do systemu firmy (np. ERP) i uzgadniając płatności dokonane lub otrzymane w czasie rzeczywistym. Jeśli przewiduje się, że saldo konta zostanie wyprzedane, firma B może natychmiast sfinansować konto z kwotą nadwyżki w rachunku bieżącym.

Wyświetlanie sald kont w jednym miejscu

Menedżer odpowiedzialny za zarządzanie gotówką firmy i zatwierdzanie wszystkich głównych płatności dla pracowników, dostawców i osób trzecich jest często zaniepokojony sporządzaniem rachunków i chce zapewnić, że konta są kapitałem przed wypłatą płatności. Za pomocą interfejsu API informacji o koncie firmowym menedżer może wyświetlać salda kont depozytowych banku USA bezpośrednio z systemu firmy bez konieczności logowania się do wielu systemów w celu wyświetlania sald w różnych kontach i bankach.

Ulepszanie raportowania skarbu

Menedżer utrzymuje pulpit nawigacyjny analizy, który zapewnia istotne informacje finansowe i szczegółowe informacje dla firmy. Menedżer chce zrozumieć, w jaki sposób salda kont depozytowych zmieniają się w czasie w odniesieniu do cyklu sprzedaży i dźwigni kredytowej. Interfejs API informacji o koncie firmowym pomaga menedżerowi ściągnąć salda kont depozytowych w USA, przeprowadzić analizę potrzebną do oceny poprzednich danych transakcji i przewidzieć wydatki finansowe.


Funkcje protokołu RTP

  • Wysyłaj transfery 24 godziny dziennie, 7 dni w tygodniu, 365 dni w roku.
  • Inicjowanie rozliczeń i rozliczanie faktur w czasie rzeczywistym oraz zarządzanie nimi.

Przykładowe przypadki użycia


Komunikaty dotyczące transferu środków

Twój zespół deweloperów musi znaleźć rozwiązanie ułatwiające klientom wysyłanie pieniędzy. Klienci muszą wysyłać pieniądze ze swoich rachunków finansowych do kontaktów przy użyciu funkcji przelewu pieniędzy. Korzystając z interfejsu API RTP®, możesz zezwolić swoim klientom z kontami sprawdzania banków w USA na wysyłanie płatności do kontaktów, w dowolnym czasie, w dowolnym miejscu.

Faktury za płatności w czasie rzeczywistym

Klient jest poręcznym użytkownikiem i współpracuje z kilkoma klientami przez cały tydzień. Wysyłka faktur i oczekiwanie na płatności, które mają zostać przejdą, jest kłopotliwe z powodu czasu i śledzenia. Wyszukując rozwiązanie, można znaleźć pakiet oprogramowania, który obejmuje natychmiastowe wysyłanie faktur przy użyciu interfejsu API RTP®. Teraz klient może poświęcać mniej czasu na śledzenie faktur i więcej czasu na inne potrzeby biznesowe lub życiowe.


Funkcje RFP

  • Inicjowanie rozliczeń i rozliczanie faktur w czasie rzeczywistym oraz zarządzanie nimi.
  • Zweryfikuj tożsamość i rejestrację biller w swojej instytucji finansowej.
  • Wysyłanie konfigurowalnych przypomnień do klientów w celu ulepszenia środowiska płatności w czasie rzeczywistym.
  • Włącz przyszłe lub częściowe płatności.

Przykładowe przypadki użycia


Łączenie przejrzystości rachunków

Klient musi zapłacić rachunek za prąd. Korzystając z interfejsu API żądania RTP® dla płatności, zespół deweloperów firmy narzędziowej tworzy opcję Żądanie płatności, która powiadamia klienta o należnej płatności. Klient może łatwo przesłać płatność i zobaczyć, że opcja Żądanie płatności została ukończona/została odebrana.

Udostępnianie klientom najbardziej natychmiastowych informacji

Deweloper średniej wielkości firmy niedawno zaimplementował interfejs API żądania RTP® dla płatności. Kolega, który pracuje na rachunkach płatnych dla firmy, zauważył różnicę w pracy z dostawcami i partnerami. Mogą teraz otrzymywać żądania zapłaty faktur w czasie rzeczywistym za pośrednictwem żądania płatności i natychmiast przesłać płatność w zamian, kończąc transakcje w ciągu kilku sekund.

Znane problemy i ograniczenia

  • Wymagany uwierzytelnianie wieloskładnikowe OAuth, nasz zespół ds. dołączania interfejsu API będzie koordynować generowanie rejestracji usługi SinglePoint i OAuth

Typowe błędy i środki zaradcze

Komunikaty o błędach są zwykle związane z problemami z uwierzytelnianiem, sprawdź, czy Twoje konto ma dostęp do konta bankowego, dla którego są wysyłane żądania. Skontaktuj się z nami , aby porozmawiać z zespołem pomocy technicznej i rozwiązać inne problemy.

Często zadawane pytania

Kto może korzystać z produktów interfejsu API banku USA?

Każdy może wyświetlić przegląd naszych produktów interfejsu API. Aby wyświetlić naszą dokumentację techniczną i skorzystać z naszych produktów, musisz utworzyć konto.

Jak utworzyć konto?

Rejestracja jest łatwa dzięki instrukcjom wyświetlanym na ekranie, które prowadzą Cię przez drogę. Jeśli potrzebujesz pomocy, skontaktuj się z nami.

Po utworzeniu konta zaloguj się, aby wyświetlić dokumentację produktu interfejsu API.

Co zrobić, jeśli nie otrzymam wiadomości e-mail aktywacji konta?

Sprawdź folder spamu poczty e-mail. Skontaktuj się z nami , jeśli nie możesz znaleźć adresu e-mail aktywacji konta.

Kto powinien skontaktować się, jeśli mam pytanie techniczne dotyczące produktu interfejsu API?

Każdy interfejs API zawiera kompleksową dokumentację techniczną, która pomoże Ci w portalu dla deweloperów. Nasz zespół pomocy technicznej jest również dostępny, aby uzyskać pomoc dotyczącą wszelkich pytań lub problemów, które mogą wystąpić za pośrednictwem formularza pomocy technicznej.

Jak zmienić nazwę użytkownika lub adres e-mail?

Prześlij formularz Skontaktuj się z nami i poinformuj nas, co musisz zmienić. Dołącz nazwę użytkownika lub adres e-mail. Wyślemy Ci wiadomość e-mail z następnymi krokami.

Jeśli nie pamiętam hasła, jak mogę go zaktualizować?

Przejdź do pozycji Nie pamiętasz hasła i wprowadź adres e-mail swojego konta. Wyślemy Ci link, aby go zmienić.

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Inicjowanie transakcji transferu środków RTP

Umożliwia aplikacjom inicjowanie transferu środków RTP. Płatnik w przelewie kredytowym powinien być klientem banku USA.

Inicjowanie żądania RTP dotyczące płatności (RFP)

Umożliwia aplikacjom zainicjowanie żądania RTP o płatność za otrzymanie pieniędzy na koncie banku USA.

Pobieranie listy kont dla autoryzowanego klienta

Pobierz listę kont dla autoryzowanego klienta.

Pobieranie sald kont dla tablicy kont dla bieżącego dnia

Pobieranie sald kont dla tablicy kont dla bieżącego dnia.

Pobieranie sald kont dla tablicy kont z poprzedniego dnia

Pobieranie sald kont dla tablicy kont z poprzedniego dnia.

Pobieranie stanu i szczegółów wysłanego protokołu RFP

Umożliwia aplikacjom pobieranie stanu i szczegółów protokołu RFP RTP zainicjowanego.

Pobieranie stanu i szczegółów wysłanej transakcji transferu środków RTP

Umożliwia aplikacjom pobieranie stanu i szczegółów transferu środków RTP zainicjowanego lub przychodzącego transferu środków.

Pobieranie transakcji konta dla bieżącego dnia

Pobieranie transakcji konta dla bieżącego dnia.

Pobieranie transakcji konta z poprzednich dni roboczych w zakresie dat

Pobieranie transakcji konta z poprzednich dni roboczych w zakresie dat.

Sprawdź, czy bank odbiorcy jest częścią sieci RTP

Sprawdź, czy bank odbiorcy jest częścią sieci RTP. Numer routingu banku odbierającego jest wymagany do sprawdzenia uprawnień RTP.

Inicjowanie transakcji transferu środków RTP

Umożliwia aplikacjom inicjowanie transferu środków RTP. Płatnik w przelewie kredytowym powinien być klientem banku USA.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek typu zawartości
Content-Type True string

Wskazuje typ nośnika zasobu.

Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

clientRequestID
clientRequestID True string

Unikatowy identyfikator zdefiniowany przez aplikację kliencka dla każdego transferu środków/RFP

nazwa
name True string

nazwa klienta banku USA, który zostanie obciążony kontem

accountNumber
accountNumber True string

Numer konta płatnika

routingNumber
routingNumber True Routing number should pass the check digit validation

Numer routingu bankowego w USA

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznego płatnika

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

imię i nazwisko płatnika, który będzie rozliczany

accountNumber
accountNumber True string

Numer konta płatnika

routingNumber
routingNumber True Routing number should pass the check digit validation

numer routingu banku odbierającego

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznej płatności

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

kwota
amount True number

Kwota do przeniesienia. Ilość powinna być sformatowana z 2 miejscami dziesiętnymi

paymentType
paymentType True string

Typ płatności RTP, która umożliwi wysłanie i odebranie banku w celu odpowiedniego przetworzenia płatności

remittanceID
remittanceID string

Identyfikacja przelewu od remt.001 w celu zidentyfikowania oddzielnej porady przelewowej wysłanej przez dłużnika, który jest związany z przelewem kredytowym

e-mail
email string

Adres e-mail, na który wysłano informacje o przelewie

URI
URI string

Identyfikator URI, w którym wysłano informacje o przekazie

dodatkoweInformacje
additionalInfo string

Służy do dostarczania dodatkowych informacji związanych z przekazywaniem

Zwraca

Nazwa Ścieżka Typ Opis
transactionID
clientDetails.transactionID string

Unikatowy identyfikator przypisany przez us Bank. Ten identyfikator może służyć do późniejszego pobrania transakcji

clientRequestID
clientDetails.clientRequestID string

Unikatowy identyfikator zdefiniowany przez aplikację kliencka dla każdego transferu środków/RFP

Inicjowanie żądania RTP dotyczące płatności (RFP)

Umożliwia aplikacjom zainicjowanie żądania RTP o płatność za otrzymanie pieniędzy na koncie banku USA.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek typu zawartości
Content-Type True string

Wskazuje typ nośnika zasobu.

Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

clientRequestID
clientRequestID True string

Unikatowy identyfikator zdefiniowany przez aplikację kliencka dla każdego transferu środków/RFP

nazwa
name True string

nazwa nadawcy

accountNumber
accountNumber True string

Numer konta nadawcy

routingNumber
routingNumber True Routing number should pass the check digit validation

Numer routingu bankowego w USA

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznej płatności

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

imię i nazwisko płatnika, do którego wysyła się RFP

accountNumber
accountNumber True string

Numer konta płatnika

routingNumber
routingNumber True Routing number should pass the check digit validation

numer routingu banku odbierającego

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

nazwa
name True string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznego płatnika

Wiersz adresu1
addressLine1 True string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city True string

Miasto zamieszkania odbiorcy.

stan
state True ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode True ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country True ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

kwota
amount True number

Kwota do przeniesienia. Ilość powinna być sformatowana z 2 miejscami dziesiętnymi

paymentType
paymentType True string

Typ płatności RTP, która umożliwi wysłanie i odebranie banku w celu odpowiedniego przetworzenia płatności

requestedExecutionDateTime
requestedExecutionDateTime True YYYY-MM-DDThh:mm:ss

Data lub data i godzina, w której ma zostać wykonana płatność. Należy podać datę i godzinę wschodnią. Jeśli podano tylko datę, zakłada się, że płatność ma być wykonywana przez dzień kalendarzowy EOD, ET

expiryDateTime
expiryDateTime True YYYY-MM-DDThh:mm:ss

Data lub data i godzina, po której dłużnik nie może zainicjować CT w odpowiedzi na ten wniosek. Data i godzina powinny być podane zgodnie z godziną wschodnią. Data nie może być wcześniejsza niż data wykonania

paymentModificationAllowed
paymentModificationAllowed True boolean

Wskazuje, czy można zapłacić kwotę inną niż żądana kwota, czy też nie

remittanceID
remittanceID string

Identyfikacja przelewu od remt.001 w celu zidentyfikowania oddzielnej porady przelewowej wysłanej przez dłużnika, który jest związany z przelewem kredytowym

e-mail
email string

Adres e-mail, na który wysłano informacje o przelewie

URI
URI string

Identyfikator URI, w którym wysłano informacje o przekazie

dodatkoweInformacje
additionalInfo string

Służy do dostarczania dodatkowych informacji związanych z przekazywaniem

fullAmount
fullAmount True number

Kwota przed zastosowaniem rabatu. To pole służy do wskazywania całkowitej kwoty należnej dla adresów RFP związanych z płatnością rachunku

discountedAmount
discountedAmount True number

Kwota po zastosowaniu rabatu. To pole służy do wskazywania minimalnej kwoty należnej dla adresów RFP związanych z płatnością rachunku

Zwraca

Nazwa Ścieżka Typ Opis
transactionID
clientDetails.transactionID string

Unikatowy identyfikator przypisany przez us Bank. Ten identyfikator może służyć do późniejszego pobrania transakcji

clientRequestID
clientDetails.clientRequestID string

Unikatowy identyfikator zdefiniowany przez aplikację kliencka dla każdego transferu środków/RFP

Pobieranie listy kont dla autoryzowanego klienta

Pobierz listę kont dla autoryzowanego klienta.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Numer strony
pageNumber string

Bieżący numer strony z wyniku zapytania w celu zwrócenia

Rozmiar strony
pageSize string

Rozmiar strony wyników

Zwraca

Nazwa Ścieżka Typ Opis
accounts
accounts array of AccountDescriptor
pageMeta
pageMeta PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Pobieranie sald kont dla tablicy kont dla bieżącego dnia

Pobieranie sald kont dla tablicy kont dla bieżącego dnia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek typu zawartości
Content-Type True string

Wskazuje typ nośnika zasobu.

Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

accountID
accountID array of string

Unikatowy identyfikator kont

accountNumber
accountNumber string

Numer konta autoryzowanego klienta

routingNumber
routingNumber string

Numer routingu autoryzowanego klienta

Typ konta
accountType string

Typ konta

pageNumber
pageNumber string

Bieżący numer strony z wyniku zapytania w celu zwrócenia

pageSize
pageSize string

Rozmiar strony wyników

Zwraca

Nazwa Ścieżka Typ Opis
accountsSummaryCurrentDay
accountsSummaryCurrentDay array of AccountSummaryCurrentDay
Ostrzeżenia
warnings array of Warnings
pageMeta
pageMeta PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Pobieranie sald kont dla tablicy kont z poprzedniego dnia

Pobieranie sald kont dla tablicy kont z poprzedniego dnia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nagłówek typu zawartości
Content-Type True string

Wskazuje typ nośnika zasobu.

Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

accountID
accountID array of string

Unikatowy identyfikator kont

accountNumber
accountNumber string

Numer konta autoryzowanego klienta

routingNumber
routingNumber string

Numer routingu autoryzowanego klienta

Typ konta
accountType string

Typ konta

pageNumber
pageNumber string

Bieżący numer strony z wyniku zapytania w celu zwrócenia

pageSize
pageSize string

Rozmiar strony wyników

Zwraca

Nazwa Ścieżka Typ Opis
accountsSummaryPreviousDay
accountsSummaryPreviousDay array of AccountSummaryPreviousDay
Ostrzeżenia
warnings array of Warnings
pageMeta
pageMeta PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Pobieranie stanu i szczegółów wysłanego protokołu RFP

Umożliwia aplikacjom pobieranie stanu i szczegółów protokołu RFP RTP zainicjowanego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Pobierany identyfikator transakcji
transactionID True string

Identyfikator transakcji skojarzony z pobieranymi transakcjami.

Zwraca

Body
RFPDetails

Pobieranie stanu i szczegółów wysłanej transakcji transferu środków RTP

Umożliwia aplikacjom pobieranie stanu i szczegółów transferu środków RTP zainicjowanego lub przychodzącego transferu środków.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Pobierany identyfikator transakcji
transactionID True string

Identyfikator transakcji skojarzony z pobieranymi transakcjami.

Zwraca

Pobieranie transakcji konta dla bieżącego dnia

Pobieranie transakcji konta dla bieżącego dnia.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Identyfikator konta
accountID True string

Unikatowy identyfikator konta

Identyfikator transakcji referencyjnej banku
bankReferenceNumber string

Unikatowy identyfikator transakcji

Numer strony
pageNumber string

Bieżący numer strony z wyniku zapytania w celu zwrócenia

Rozmiar strony
pageSize string

Rozmiar strony wyników

Zwraca

Nazwa Ścieżka Typ Opis
transakcje
transactions array of Transaction
lastRefreshedDateTime
lastRefreshedDateTime lastRefreshedDateTime

Format daty ISO 8601, z którego pochodzą dane.

pageMeta
pageMeta PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Pobieranie transakcji konta z poprzednich dni roboczych w zakresie dat

Pobieranie transakcji konta z poprzednich dni roboczych w zakresie dat.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Identyfikator konta
accountID True string

Unikatowy identyfikator konta

Data rozpoczęcia
startDate string

Data/godzina rozpoczęcia pobierania transakcji. ISO 8601.

Data zakończenia
endDate string

Data/godzina zakończenia pobierania transakcji. ISO 8601.

Numer strony
pageNumber string

Bieżący numer strony z wyniku zapytania w celu zwrócenia

Rozmiar strony
pageSize string

Rozmiar strony wyników

Zwraca

Nazwa Ścieżka Typ Opis
transakcje
transactions array of Transaction
pageMeta
pageMeta PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Sprawdź, czy bank odbiorcy jest częścią sieci RTP

Sprawdź, czy bank odbiorcy jest częścią sieci RTP. Numer routingu banku odbierającego jest wymagany do sprawdzenia uprawnień RTP.

Parametry

Nazwa Klucz Wymagane Typ Opis
Zaakceptuj nagłówek
Accept True string

aplikacja/json

nagłówek Accept-Encoding
Accept-Encoding True string

Accept-Encoding

Unikatowy identyfikator dla każdej pary odpowiedzi żądania
Correlation-ID True GUID

Unikatowy identyfikator dla każdej pary odpowiedzi żądania

Identyfikator klienta banku USA, dla którego dotyczy to żądanie
On-Behalf-Of string

Identyfikator klienta banku USA, jeśli żądanie interfejsu API jest przesyłane przez dostawcę usług w imieniu klienta. To pole jest wymagane warunkowo.

Numer routingu bankowego do zweryfikowania
routingNumber True string

9-cyfrowy numer routingu banku odbiorcy

Zwraca

Zawiera informacje o uprawnieniach protokołu RTP dla numeru routingu

Definicje

Address

Nazwa Ścieżka Typ Opis
Wiersz adresu1
addressLine1 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

Wiersz adresu2
addressLine2 string

Adres główny adresata. Dołącz numer domu, nazwę ulicy, numer mieszkania itp.

city
city string

Miasto zamieszkania odbiorcy.

stan
state ISO 3166-2:US

Stan zamieszkania odbiorcy.

Kod pocztowy
zipCode ##### or #####-####

Kod pocztowy rezydenta odbiorcy.

country
country ISO 3166 CountryCode

Kraj zamieszkania odbiorcy. Dozwolona wartość to US.

ClientDetails

Nazwa Ścieżka Typ Opis
clientRequestID
clientRequestID string

Unikatowy identyfikator zdefiniowany przez aplikację kliencka dla każdego transferu środków/RFP

UltimatePayer

Szczegóły ostatecznej płatności w przypadku płatnika są pośredniczące. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznego płatnika

address
address Address

UltimatePayee

Ultimate payee details incasee is pośrednictwa. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa ostatecznego płatnika

identyfikator
identifier string

Identyfikator ostatecznej płatności

address
address Address

TransactionResponse

Nazwa Ścieżka Typ Opis
clientDetails
transactiondDetails.clientDetails ClientDetails
transactionID
transactiondDetails.transactionID string

Identyfikator transakcji przelewu środków

originalRFPTransactionID
transactiondDetails.originalRFPTransactionID string

Identyfikator transakcji oryginalnego RFP w przypadku przeniesienia środków jest w odpowiedzi na RFP

typ transakcji
transactiondDetails.transactionType string

Czy transakcja jest transakcją przychodzącą, czy wychodzącą transakcją

kod statusu
transactiondDetails.status.statusCode string
komunikat
transactiondDetails.status.message string

Dodatkowe szczegóły stanu transakcji

kwota
transactiondDetails.amount number

Kwota transakcji

nazwa
transactiondDetails.payerDetails.name string

Nazwa płatnika

accountNumber
transactiondDetails.payerDetails.accountNumber string

Ostatnie 4 cyfry numeru konta płatnika, który został użyty do dokonania płatności.

address
transactiondDetails.payerDetails.address Address
ultimatePayerDetails
transactiondDetails.ultimatePayerDetails UltimatePayer

Szczegóły ostatecznej płatności w przypadku płatnika są pośredniczące. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

nazwa
transactiondDetails.payeeDetails.name string

Nazwa płatnika

accountNumber
transactiondDetails.payeeDetails.accountNumber string

Ostatnie 4 cyfry numeru konta odbiorcy

routingNumber
transactiondDetails.payeeDetails.routingNumber string

Numer routingu banku płatnika

address
transactiondDetails.payeeDetails.address Address
ultimatePayeeDetails
transactiondDetails.ultimatePayeeDetails UltimatePayee

Ultimate payee details incasee is pośrednictwa. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

remittanceID
transactiondDetails.remittanceData.remittanceID string

Identyfikacja przelewu od remt.001 w celu zidentyfikowania oddzielnej porady przelewowej wysłanej przez dłużnika, który jest związany z przelewem kredytowym

e-mail
transactiondDetails.remittanceData.remittanceLocationDetails.email string

Adres e-mail, na który wysłano informacje o przelewie

URI
transactiondDetails.remittanceData.remittanceLocationDetails.URI string

Identyfikator URI, w którym wysłano informacje o przekazie

dodatkoweInformacje
transactiondDetails.remittanceData.additionalInfo string

Służy do dostarczania dodatkowych informacji związanych z przekazywaniem

RFPDetails

Nazwa Ścieżka Typ Opis
clientDetails
requestForPayment.clientDetails ClientDetails
typ transakcji
requestForPayment.transactionType string

Czy transakcja jest transakcją przychodzącą, czy wychodzącą transakcją

kod statusu
requestForPayment.status.statusCode string
komunikat
requestForPayment.status.message string

Dodatkowe szczegóły transakcji

nazwa
requestForPayment.payeeDetails.name string

nazwa nadawcy

accountNumber
requestForPayment.payeeDetails.accountNumber string

Numer konta nadawcy

routingNumber
requestForPayment.payeeDetails.routingNumber string

numer routingu banku wysyłającego

ultimatePayeeDetails
requestForPayment.ultimatePayeeDetails UltimatePayee

Ultimate payee details incasee is pośrednictwa. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

nazwa
requestForPayment.payerDetails.name string

imię i nazwisko płatnika, do którego wysyła się RFP

accountNumber
requestForPayment.payerDetails.accountNumber string

Numer konta płatnika

routingNumber
requestForPayment.payerDetails.routingNumber string

numer routingu banku odbierającego

ultimatePayerDetails
requestForPayment.ultimatePayerDetails UltimatePayer

Szczegóły ostatecznej płatności w przypadku płatnika są pośredniczące. Należy używać tylko dla parametru paymentType "POŚREDNICTWA"

transactionID
requestForPayment.requestDetails.transactionID string

Identyfikator transakcji przypisany przez us Bank.

kwota
requestForPayment.requestDetails.amount number

Kwota do przeniesienia. Ilość powinna być sformatowana z 2 miejscami dziesiętnymi

paymentType
requestForPayment.requestDetails.paymentType string

Typ płatności RTP, która umożliwi wysłanie i odebranie banku w celu odpowiedniego przetworzenia płatności

requestedExecutionDateTime
requestForPayment.requestDetails.requestedExecutionDateTime string

Data lub data i godzina, w której ma zostać wykonana płatność. Jeśli podano tylko datę, zakłada się, że płatność ma być wykonywana przez dzień kalendarzowy EOD, ET

expiryDateTime
requestForPayment.requestDetails.expiryDateTime string

Data lub data i godzina, po której dłużnik nie może zainicjować CT w odpowiedzi na ten wniosek. Data nie może być wcześniejsza niż data wykonania

paymentModificationAllowed
requestForPayment.requestDetails.paymentModificationAllowed boolean

Wskazuje, czy można zapłacić kwotę inną niż żądana kwota, czy też nie

responseDetails
requestForPayment.responseDetails RFPResponseDetails
remittanceID
requestForPayment.remittanceData.remittanceID string

Identyfikacja przelewu od remt.001 w celu zidentyfikowania oddzielnej porady przelewowej wysłanej przez dłużnika, który jest związany z przelewem kredytowym

e-mail
requestForPayment.remittanceData.remittanceLocationDetails.email string

Adres e-mail, na który wysłano informacje o przelewie

URI
requestForPayment.remittanceData.remittanceLocationDetails.URI string

Identyfikator URI, w którym wysłano informacje o przekazie

dodatkoweInformacje
requestForPayment.remittanceData.additionalInfo string

Służy do dostarczania dodatkowych informacji związanych z przekazywaniem

fullAmount
requestForPayment.remittanceData.discountDetails.fullAmount number

Kwota przed zastosowaniem rabatu. To pole służy do wskazywania całkowitej kwoty należnej dla adresów RFP związanych z płatnością rachunku

discountedAmount
requestForPayment.remittanceData.discountDetails.discountedAmount number

Kwota po zastosowaniu rabatu. To pole służy do wskazywania minimalnej kwoty należnej dla adresów RFP związanych z płatnością rachunku

RFPResponseDetails

Nazwa Ścieżka Typ Opis
responseCode (kod odpowiedzi)
responseCode string

Przechwytuje typ odpowiedzi.
Zaplanowane — RFP zaplanowane na przyszłość
Odrzuć — RFP nie zostanie wypłacona.

creditTransfertransactionIDs
creditTransfertransactionIDs array of string

Identyfikatory transakcji przelewów kredytowych na wypadek wysłania wszelkich przelewów kredytowych w odpowiedzi na RFP

rejectReason
rejectionDetails.rejectReason string

Przyczyna odrzucenia została wysłana przez odbiorcę

dodatkowe informacje
rejectionDetails.additionalInformation string

Dodatkowe informacje o przyczynie odrzucenia

amountAccepted
scheduledPaymentDetails.amountAccepted number

Kwota zaakceptowana, jeśli modyfikacja płatności jest dozwolona w oryginalnym RFP

earlyPaymentIndicator
scheduledPaymentDetails.earlyPaymentIndicator boolean

Wskazuje, czy dłużnik zgadza się zapłacić w dniu lub przed żądaną datą, czy też nie

scheduledDateTime
scheduledPaymentDetails.scheduledDateTime YYYY-MM-DDThh:mm:ss

Data lub data i godzina, w której zaplanowano płatność

RTPEligibilityResponse

Zawiera informacje o uprawnieniach protokołu RTP dla numeru routingu

Nazwa Ścieżka Typ Opis
rtpEligible
rtpEligible boolean

Wskazuje, czy podany numer routingu jest częścią sieci RTP

AccountDescriptor

Lekkie podsumowanie konta

Nazwa Ścieżka Typ Opis
accountID
accountID string

Unikatowy identyfikator konta

accountName
accountName string

Nazwa konta

accountNumber
accountNumber string

Numer konta autoryzowanego klienta

routingNumber
routingNumber string

Numer routingu autoryzowanego klienta

bankName
bankName string

Nazwa banku klientów

Typ konta
accountType string

Typ konta

waluta
currency string

Kod waluty ISO transakcji lub salda

PageMeta

Aby zminimalizować czasy odpowiedzi dla żądań i ogólnie poprawić środowisko użytkownika końcowego

Nazwa Ścieżka Typ Opis
pageNumber
pageNumber number

Bieżący numer strony

pageSize
pageSize number

Wyniki na stronę

pageCount
pageCount number

Łączna liczba stron w zestawie wyników

totalCount
totalCount number

Łączna liczba rekordów wyników

links
links PageLinks

links

Łącza stron

links

Nazwa Ścieżka Typ Opis
Poprzedni
prev string

Adres URL poprzedniej strony

następny
next string

Adres URL następnej strony

Warnings

Jednostka ostrzegawcza, która może być używana na poziomie interfejsu API na potrzeby pomyślnych odpowiedzi.

Nazwa Ścieżka Typ Opis
kod
code string

Długoterminowy trwały identyfikator, który może służyć do śledzenia warunku ostrzeżenia z powrotem w celu rejestrowania informacji

komunikat
message string

Użytkownik końcowy wyświetlający informacje, jest to czytelny dla człowieka tekst, który zapewnia wysoką kategoryzację ostrzeżenia, które wystąpiło

details
details array of object
attributeName (nazwa_atrybutu)
details.attributeName string
powód
details.reason string

AccountSummaryCurrentDay

Szczegóły konta rozszerza i dziedziczy wszystkie pola z klasy AccountDescriptor.

Szczegóły konta rozszerza i dziedziczy wszystkie pola z klasy AccountDescriptor.

AccountSummaryPreviousDay

Szczegóły konta rozszerza i dziedziczy wszystkie pola z klasy AccountDescriptor.

Szczegóły konta rozszerza i dziedziczy wszystkie pola z klasy AccountDescriptor.

Sprawdza

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

Nazwa Ścieżka Typ Opis
captureDate
captureDate date

Data przechwycenia sprawdzania

lastRefreshedDateTime

Format daty ISO 8601, z którego pochodzą dane.

Format daty ISO 8601, z którego pochodzą dane.

ACH

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

Nazwa Ścieżka Typ Opis
companyName
companyName string

Nazwa firmy

individualID
individualID string

Identyfikator indywidualny

identyfikator firmy
companyID string

Identyfikator firmy

secCode
secCode string

Kod SEC

companyDiscretionaryData
companyDiscretionaryData string

DANE UZNANIOWE FIRMY

entryDescription
entryDescription string

Opis wpisu

effectiveEntryDate
effectiveEntryDate date

Data wejścia obowiązującego transakcji

RTP

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

Nazwa Ścieżka Typ Opis
utworzone
created date

Data utworzenia transakcji

dłużnikClientReference
debtorClientReference string

Numer referencyjny klienta dłużnika

dłużnikBankReference
debtorBankReference string

Numer referencyjny dłużnika bankowego

nazwa dłużnika
debtorName string

Nazwa dłużnika

dłużnyKonto
debtorAccount string

Rachunek dłużnika

identyfikator dłużnikaBankID
debtorBankID string

Identyfikator banku dłużnika

dłużnych Banków
debtorBank string

Bank Dłużnika

dłużnychaddress
debtorAddress string

Adres dłużnika

nazwa_wierzyciela
creditorName string

Nazwa wierzyciela

wierzycielAccount
creditorAccount string

Rachunek wierzyciela

wierzycielBankID
creditorBankID string

Identyfikator banku wierzyciela

wierzycielBank
creditorBank string

Bank wierzycieli

wierzycielAddress
creditorAddress string

Adres wierzyciela

Zelle

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

Nazwa Ścieżka Typ Opis
receiverName
receiverName string

Nazwa odbiorcy

alias
alias string

Pseudonim

paymentType
paymentType string

Typ płatności

effectiveDate (data obowiązywania)
effectiveDate date

Data wejścia w życie

paymentInstructionID
paymentInstructionID string

paymentInstructionID

nazwa parametru
parameterName string

Nazwa parametru

parametrWartość
parameterValue string

Wartość parametru

Przewody

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

Nazwa Ścieżka Typ Opis
parNumber
parNumber string

Numer par

przesłać źródło
source string

Źródło

repeatCode
repeatCode string

Powtórz kod

pomysłodawca
originator string

Informacje o inicjatorze

originatorBank
originatorBank string

Nazwa banku inicjująca

beneficjentReference
beneficiaryReference string

ODWOŁANIE BENEFICJENTA

beneficjent
beneficiary string

Beneficjent

beneficjentBank
beneficiaryBank string

Nazwa banku beneficjenta

originatorToBeneficiaryInfo
originatorToBeneficiaryInfo string

INICJATOR INFORMACJI O BENEFICJENTACH

sendingBank
sendingBank string

Nazwa banku nadawcy

pośrednikBank
intermediaryBank string

NAZWA BANKU POŚREDNICZĄCEGO

receivingBank
receivingBank string

Odbieranie nazwy banku

receivedDate
receivedDate date

Data/godzina odebrania

completedDate
completedDate date

Data/godzina ukończenia

zainicjowane przez
initiatedBy string

Jednostka, która zainicjowała transfer

approvedBy
approvedBy string

Jednostka, która zatwierdziła transfer

bankToBankInfo
bankToBankInfo string

Bank to Bank Transfer Information

imad
imad string

Numer IMAD

fedReference
fedReference string

Numer referencyjny federalny

controlNumber
controlNumber string

Numer kontrolny

Transakcja

Podstawowe informacje o koncie.

Nazwa Ścieżka Typ Opis
accountID
accountID string

Unikatowy identyfikator konta

dataTransakcji
transactionDate string

Data zaksięgowana transakcji

debitCreditIndicator
debitCreditIndicator string

Wskaźnik debetowy/kredytowy

transactionDescription
transactionDescription string

Opis transakcji

typ transakcji
transactionType string

Typ transakcji

Kod BAICode
BAICode string

Bank Administration Institute kod transakcji

transactionReferenceNumber
transactionReferenceNumber string

Ten atrybut jest identyfikatorem podanym przez klienta dla każdej transakcji. Może on być lub nie może być powtórzony w zależności od tego, czy jest dostarczany przez klienta, czy zamapowany przez nasz system.

bankReferenceNumber
bankReferenceNumber string

Ten atrybut to system bankowy wygenerowany unikatowy identyfikator transakcji dla każdej transakcji. Dotyczy to następujących typów transakcji
1. W przypadku transakcji RTP bankReferenceNumber jest unikatowym identyfikatorem
transakcji 2. W przypadku transakcji BookTransfers bankReferenceNumber jest unikatowym identyfikatorem
transakcji 3. W przypadku checkDeposits/CheckPaid/Cont Disb Checks/Wychodzący list gotówkowy bankReferenceNumber jest unikatowym identyfikatorem transakcji.
4. W przypadku transakcji ACH bankReferenceNumber odnosi się do numeru PAR dostarczonego przez sieć
ACH 5. W przypadku transakcji Zelle bankReferenceNumber odnosi się do wartości paymentInstructionID
6. W przypadku transakcji przewodowych bankReferenceNumber odnosi się do numeru PAR dostarczonego przez sieć fed/swift

kwota
amount number

Kwota transakcji

waluta
currency string

Kod waluty ISO transakcji lub salda

achTransactionDetails
achTransactionDetails ACH

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

rtpTransactionDetails
rtpTransactionDetails RTP

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

zelleTransactionDetails
zelleTransactionDetails Zelle

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

checksTransactionDetails
checksTransactionDetails Checks

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

wiresTransactionDetails
wiresTransactionDetails Wires

Dostępność pól w poniższym obiekcie zależy od typu transakcji.

dodatkowe informacje
additionalInformation array of string