---
title: USBankAPIs
summary: API reference for USBankAPIs.
status: draft
owner: SAIF
last_reviewed: 2026-07-24
library: SAIF.Business.EPay.USBank
reference_type: package
---

# USBankAPIs

`USBankAPIs` is the handwritten façade over the generated `epayWebServiceService` proxy. It owns request mapping, certificate-backed client creation, and response handling for the primary US Bank gateway.

## Purpose
- Expose the main US Bank payment-gateway operations used by SAIF callers.
- Normalize outbound payloads and translate gateway responses into caller-facing outcomes.

## Context
- Namespace: `SAIF.Business.EPay.USBank`
- Assembly/package: `SAIF.BOF.Business.EPay.USBank`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| UpdateRecurringAuthorizationAmountAndDate | `Public Sub UpdateRecurringAuthorizationAmountAndDate(inUSBankUserSeqNum As Decimal, inAmount As Decimal, inPaymentDate As Date, inIsVoluntary As Boolean, inUSBankEPayWebService As epayWebServiceService)` | Executes `UpdateRecurringAuthorizationAmountAndDate`. |
| PerformUSBankHealthCheck | `Public Function PerformUSBankHealthCheck() As Boolean` | Returns the result of `PerformUSBankHealthCheck`. |
| RegisterUser | `Public Function RegisterUser(ByVal inDPI As IDataPortalInfo, inUserInfo As IUserInfoProvider, ByVal inPolicyInfo As IPolicyInfoProvider) As clsUSBankUser` | Returns the result of `RegisterUser`. |
| AddBankAccountResults | `Public Class AddBankAccountResults` | Exposes the nested `AddBankAccountResults` type declared on this parent type. |
| AddBankAccount | `Public Function AddBankAccount(inBankAccount As IBankAccount, inUSBankUser As IUSBankUser, inIsPolicyVoluntary As Boolean) As AddBankAccountResults` | Returns the result of `AddBankAccount`. |
| CancelPayment | `Public Function CancelPayment(ByVal inConfirmationId As String, ByVal inIsVoluntary As Boolean) As Boolean` | Returns the result of `CancelPayment`. |
| StopRecurringPayment | `Public Sub StopRecurringPayment(inRecurringConfirmationId As String, ByVal inIsVoluntary As Boolean)` | Executes `StopRecurringPayment`. |
| UpdateRecurringAuthorizationAmountAndDate | `Public Sub UpdateRecurringAuthorizationAmountAndDate(inUSBankUser As IUSBankUser, inAmount As Decimal, inPaymentDate As Date, inIsVoluntary As Boolean)` | Executes `UpdateRecurringAuthorizationAmountAndDate`. |
| UpdateRecurringAuthorizationAmountAndDate | `Public Sub UpdateRecurringAuthorizationAmountAndDate(inUSBankUserSeqNum As Decimal, inAmount As Decimal, inPaymentDate As Date, inIsVoluntary As Boolean)` | Executes `UpdateRecurringAuthorizationAmountAndDate`. |
| EstablishRecurringAuthorization | `Public Function EstablishRecurringAuthorization(inUSBankUser As IUSBankUser, inPolicyNumber As Decimal, inPolicyName As String, inBankAccount As IBankAccount, inIsVoluntary As Boolean) As String` | Returns the result of `EstablishRecurringAuthorization`. |
| GetUserId | `Public Function GetUserId(ByVal inEmailAddress As String, inIsVoluntary As Boolean) As String` | Returns the result of `GetUserId`. |
| GetPaymentInfo | `Public Function GetPaymentInfo(inUSBankUser As IUSBankUser, inIsVoluntary As Boolean) As String` | Returns the result of `GetPaymentInfo`. |

## Behavioral notes
- The module attaches an X.509 client certificate before sending primary SOAP requests.

## Constraints and usage notes
- Runtime behavior depends on externally supplied endpoints and certificate availability.

## Sources
- `Business\SAIF.Business.EPay.USBank\USBankAPIs.vb`