The FundingAccount wrapper module.
Members
-
inner aba_routing_number :String
-
The ABA/Routing number for the bank account.
-
inner account_holder_name :String
-
The name as specified on the account.
-
inner account_holder_type :String
-
The type of ownership for the funding account. This is applicable only in the case of bank accounts and it is defaults to personal.
-
inner account_number :String
-
The number or reference that a customer uses to identify the funding account.
-
inner account_subtype :String
-
The sub type of the funding account. This is derived by Orbipay in the case of card funding accounts. It needs to be passed when adding or editing a DDA/bank account. For e.g., a savings account, a checking account.
-
inner account_type :String
-
The type of the funding account.
-
inner ach_eligible_flag :String
-
Indicates if the funding account can be debited vide ACH, in case the funding account is a Demand Deposit Account (DDA).
-
inner address :Address
-
-
inner atm_eligible_flag :String
-
Indicates if the funding account can be debited vide the ATM Rail network, in case the funding account is a Debit Card.
-
inner audit_info :AuditInfo
-
-
inner card_cvv_number :String
-
This is never returned by Orbipay. This needs to be passed to Orbipay when adding or editing a card funding account.
-
inner comments :String
-
Comments that can be used to recollect the operation performed on the resource object. API clients need to ensure that no sensitive information is passed in the memo. Alacriti (Orbipay) is not responsible for the security of any sensitive information that may be passed as part of the memo.
-
inner currency_code3d :String
-
The three-letter currency code in the ISO4217 format, in uppercase, for the card account. It must be a currency supported by Orbipay. This defaults to USD.
-
inner custom_fields :Object
-
The additional information or meta-information that Orbipay can accept, maintain and transmit back to the client. The custom fields need to be configured with Orbipay before they can be accepted. Orbipay would reject custom fields that are not pre-configured. Please contact <a href = "mailto: support@billerpayments.com">support@billerpayments.com for more information on configuring and using custom fields. Only the custom fields enabled for the client, in Orbipay, would be accepted in the requests.
-
inner deleted :String
-
The status of funding account which says whether the funding account is deleted or not
-
inner expiry_date :String
-
The expiry date for the card. This is to be in the format MM/yy. Only applicable for cards accounts.
-
inner id :String
-
Id is a unique identifier assigned to the funding account in Orbipay. A new Id is generated for the funding account when the account number is updated.
-
inner ID_CUSTOMER :String
-
The unique identifier assigned by EBPP to the customer.
-
inner ID_FUNDING_ACCOUNT :String
-
The unique identifier assigned by EBPP to the Funding Account.
-
inner issuer_name :String
-
The name of the authority that has issued the account. This is relevant only in the case of bank accounts.
-
inner nickname :String
-
The nickname by which a customer might want to identify the account.
-
inner status :String
-
The status of the funding account in Orbipay.
-
inner url :String
-
This URL fetches the funding account details.
Methods
-
static constructFromObject(data, obj) → {module:wrappers/FundingAccount}
-
Constructs a
FundingAccountfrom a plain JavaScript object, optionally creating a new instance. Copies all relevant properties fromdatatoobjif supplied or a new instance if not.Parameters:
Name Type Description dataObject The plain JavaScript object bearing properties of interest.
objmodule:wrappers/FundingAccount Optional instance to populate.
-
forClient(client_key) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description client_keyString The client_key of FundingAccount.
-
forCustomer(ID_CUSTOMER) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description ID_CUSTOMERString The ID_CUSTOMER of FundingAccount.
-
videChannel(channel) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description channelString The channel of FundingAccount.
-
withAddress(address) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description addressAddress The address of FundingAccount.
-
withCustomFields(custom_fields) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description custom_fieldsObject The custom_fields of FundingAccount.
-
withDetails(account_holder_name, nickname, account_number, account_subtype, aba_routing_number, card_cvv_number, expiry_date, account_holder_type) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description account_holder_nameString The account_holder_name of FundingAccount.
nicknameString The nickname of FundingAccount.
account_numberString The account_number of FundingAccount.
account_subtypeString The account_subtype of FundingAccount.
aba_routing_numberString The aba_routing_number of FundingAccount.
card_cvv_numberString The card_cvv_number of FundingAccount.
expiry_dateString The expiry_date of FundingAccount.
account_holder_typeString The account_holder_type of FundingAccount.
-
withMemo(comments) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description commentsString The comments of FundingAccount.
-
withRecordedDetails(account_number, issuer_name) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description account_numberString The account_number of FundingAccount.
issuer_nameString The issuer_name of FundingAccount.
-
withStatus(status) → {module:wrappers/FundingAccount}
-
Parameters:
Name Type Description statusString The status of FundingAccount.