@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/virtual-account-services
VictorVirtualAccountService
Class VictorVirtualAccountService
Index
Constructors
constructor
Methods
create
delete
update
Constructors
constructor
new
VictorVirtualAccountService
(
args
:
{
bankAdminService
:
BankAdminService
;
db
:
B2bDatabase
;
entityService
:
EntityService
;
eventPublisher
:
CustomerEventPublisher
;
ledgerAccountQueryService
:
LedgerAccountQueryService
;
victorAccountClient
:
VictorAccountClient
;
victorAccountQueryService
:
VictorAccountQueryService
;
virtualAccountQueryService
:
VirtualAccountQueryService
;
}
,
)
:
VictorVirtualAccountService
Parameters
args
:
{
bankAdminService
:
BankAdminService
;
db
:
B2bDatabase
;
entityService
:
EntityService
;
eventPublisher
:
CustomerEventPublisher
;
ledgerAccountQueryService
:
LedgerAccountQueryService
;
victorAccountClient
:
VictorAccountClient
;
victorAccountQueryService
:
VictorAccountQueryService
;
virtualAccountQueryService
:
VirtualAccountQueryService
;
}
Returns
VictorVirtualAccountService
Methods
create
create
(
args
:
{
customerId
:
string
;
ledgerAccountId
:
string
;
name
?:
string
;
referenceId
?:
string
|
null
;
}
,
)
:
Promise
<
|
{
ok
:
true
;
value
:
{
accountNumber
:
string
;
achDepositInstructions
:
AchDepositInstructions
|
null
;
createdAt
:
Date
;
data
:
|
{
provider
:
"VICTOR"
;
victorId
:
string
;
victorLedgerProgramId
:
string
;
}
|
{
entityId
:
string
;
entityInput
?:
{
businessAddress1
:
string
;
businessAddress2
?:
string
;
businessCity
:
string
;
businessCountry
:
string
;
businessName
:
string
;
businessPostalCode
:
string
;
businessStateProvinceRegion
?:
string
;
businessType
?:
|
"b_corporation"
|
"c_corporation"
|
"close_corporation"
|
"cooperative"
|
"general_partnership"
|
"limited_liability_company"
|
"limited_partnership"
|
"nonprofit_corporation"
|
"s_corporation"
|
"sole_proprietorship"
|
"non_us"
;
contactFirstName
:
string
;
contactLastName
:
string
;
email
:
string
;
incorporationDate
?:
string
;
phone
?:
string
;
phoneCountry
?:
string
;
taxNumber
?:
string
;
websiteUrl
?:
string
;
}
;
fundingInstructions
:
|
{
accountHolderAddress1
?:
string
|
null
;
accountHolderAddress2
?:
string
|
null
;
accountHolderCity
?:
string
|
null
;
accountHolderCountry
?:
string
|
null
;
accountHolderName
:
string
|
null
;
accountHolderPostalCode
?:
string
|
null
;
accountHolderStateProvinceRegion
?:
string
|
null
;
accountNumber
:
string
|
null
;
bankAddress1
?:
string
|
null
;
bankAddress2
?:
string
|
null
;
bankCity
?:
string
|
null
;
bankCountry
:
string
|
null
;
bankName
:
string
|
null
;
bankPostalCode
?:
string
|
null
;
bankStateProvinceRegion
?:
string
|
null
;
currency
:
string
|
null
;
message
?:
string
|
null
;
qr
?:
{
base64Image
:
...
;
expirationDate
:
...
;
qrDecoded
:
...
}
|
null
;
reference
:
string
|
null
;
routingCode
:
string
|
null
;
routingCodeAlternate
?:
string
|
null
;
swiftBic
:
string
|
null
;
taxNumber
?:
string
|
null
;
type
:
string
|
null
;
}
|
null
;
programId
:
string
;
provider
:
"ROUTE_FUSION"
;
walletId
:
string
;
}
|
null
;
deletedAt
:
Date
|
null
;
id
:
string
;
name
:
string
|
null
;
providerDepositInstructions
:
ProviderDepositInstructions
|
null
;
providerId
:
string
;
providerName
:
string
;
providerType
:
"ROUTE_FUSION"
|
"VICTOR"
|
"BIVO"
|
"MANUAL"
;
referenceId
:
string
|
null
;
routingNumber
:
string
;
rtpDepositInstructions
:
RtpDepositInstructions
|
null
;
status
:
"ACTIVE"
|
"FAILED"
|
"PENDING"
|
"INACTIVE"
;
swiftDepositInstructions
:
|
(
|
Omit
<
UsdSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
|
Omit
<
ForeignSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
)
[]
|
null
;
type
:
"US_DDA"
|
"US_DEPOSIT"
;
updatedAt
:
Date
;
walletAddress
:
Address
;
wireDepositInstructions
:
UsWireDepositInstructions
|
null
;
}
&
{
customerId
:
string
;
entityId
:
string
;
ledgerAccountId
:
string
}
;
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
Parameters
args
:
{
customerId
:
string
;
ledgerAccountId
:
string
;
name
?:
string
;
referenceId
?:
string
|
null
;
}
Returns
Promise
<
|
{
ok
:
true
;
value
:
{
accountNumber
:
string
;
achDepositInstructions
:
AchDepositInstructions
|
null
;
createdAt
:
Date
;
data
:
|
{
provider
:
"VICTOR"
;
victorId
:
string
;
victorLedgerProgramId
:
string
;
}
|
{
entityId
:
string
;
entityInput
?:
{
businessAddress1
:
string
;
businessAddress2
?:
string
;
businessCity
:
string
;
businessCountry
:
string
;
businessName
:
string
;
businessPostalCode
:
string
;
businessStateProvinceRegion
?:
string
;
businessType
?:
|
"b_corporation"
|
"c_corporation"
|
"close_corporation"
|
"cooperative"
|
"general_partnership"
|
"limited_liability_company"
|
"limited_partnership"
|
"nonprofit_corporation"
|
"s_corporation"
|
"sole_proprietorship"
|
"non_us"
;
contactFirstName
:
string
;
contactLastName
:
string
;
email
:
string
;
incorporationDate
?:
string
;
phone
?:
string
;
phoneCountry
?:
string
;
taxNumber
?:
string
;
websiteUrl
?:
string
;
}
;
fundingInstructions
:
|
{
accountHolderAddress1
?:
string
|
null
;
accountHolderAddress2
?:
string
|
null
;
accountHolderCity
?:
string
|
null
;
accountHolderCountry
?:
string
|
null
;
accountHolderName
:
string
|
null
;
accountHolderPostalCode
?:
string
|
null
;
accountHolderStateProvinceRegion
?:
string
|
null
;
accountNumber
:
string
|
null
;
bankAddress1
?:
string
|
null
;
bankAddress2
?:
string
|
null
;
bankCity
?:
string
|
null
;
bankCountry
:
string
|
null
;
bankName
:
string
|
null
;
bankPostalCode
?:
string
|
null
;
bankStateProvinceRegion
?:
string
|
null
;
currency
:
string
|
null
;
message
?:
string
|
null
;
qr
?:
{
base64Image
:
...
;
expirationDate
:
...
;
qrDecoded
:
...
}
|
null
;
reference
:
string
|
null
;
routingCode
:
string
|
null
;
routingCodeAlternate
?:
string
|
null
;
swiftBic
:
string
|
null
;
taxNumber
?:
string
|
null
;
type
:
string
|
null
;
}
|
null
;
programId
:
string
;
provider
:
"ROUTE_FUSION"
;
walletId
:
string
;
}
|
null
;
deletedAt
:
Date
|
null
;
id
:
string
;
name
:
string
|
null
;
providerDepositInstructions
:
ProviderDepositInstructions
|
null
;
providerId
:
string
;
providerName
:
string
;
providerType
:
"ROUTE_FUSION"
|
"VICTOR"
|
"BIVO"
|
"MANUAL"
;
referenceId
:
string
|
null
;
routingNumber
:
string
;
rtpDepositInstructions
:
RtpDepositInstructions
|
null
;
status
:
"ACTIVE"
|
"FAILED"
|
"PENDING"
|
"INACTIVE"
;
swiftDepositInstructions
:
|
(
|
Omit
<
UsdSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
|
Omit
<
ForeignSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
)
[]
|
null
;
type
:
"US_DDA"
|
"US_DEPOSIT"
;
updatedAt
:
Date
;
walletAddress
:
Address
;
wireDepositInstructions
:
UsWireDepositInstructions
|
null
;
}
&
{
customerId
:
string
;
entityId
:
string
;
ledgerAccountId
:
string
}
;
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
delete
delete
(
args
:
{
customerId
:
string
;
id
:
string
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
undefined
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
Parameters
args
:
{
customerId
:
string
;
id
:
string
}
Returns
Promise
<
{
ok
:
true
;
value
:
undefined
}
|
{
error
:
ServiceError
;
ok
:
false
}
>
update
update
(
args
:
{
customerId
:
string
;
id
:
string
;
name
?:
string
|
null
;
referenceId
?:
string
|
null
;
}
,
)
:
Promise
<
|
{
error
:
ServiceError
;
ok
:
false
}
|
{
ok
:
true
;
value
:
{
accountNumber
:
string
;
achDepositInstructions
:
AchDepositInstructions
|
null
;
createdAt
:
Date
;
data
:
|
{
provider
:
"VICTOR"
;
victorId
:
string
;
victorLedgerProgramId
:
string
;
}
|
{
entityId
:
string
;
entityInput
?:
{
businessAddress1
:
string
;
businessAddress2
?:
string
;
businessCity
:
string
;
businessCountry
:
string
;
businessName
:
string
;
businessPostalCode
:
string
;
businessStateProvinceRegion
?:
string
;
businessType
?:
|
"b_corporation"
|
"c_corporation"
|
"close_corporation"
|
"cooperative"
|
"general_partnership"
|
"limited_liability_company"
|
"limited_partnership"
|
"nonprofit_corporation"
|
"s_corporation"
|
"sole_proprietorship"
|
"non_us"
;
contactFirstName
:
string
;
contactLastName
:
string
;
email
:
string
;
incorporationDate
?:
string
;
phone
?:
string
;
phoneCountry
?:
string
;
taxNumber
?:
string
;
websiteUrl
?:
string
;
}
;
fundingInstructions
:
|
{
accountHolderAddress1
?:
string
|
null
;
accountHolderAddress2
?:
string
|
null
;
accountHolderCity
?:
string
|
null
;
accountHolderCountry
?:
string
|
null
;
accountHolderName
:
string
|
null
;
accountHolderPostalCode
?:
string
|
null
;
accountHolderStateProvinceRegion
?:
string
|
null
;
accountNumber
:
string
|
null
;
bankAddress1
?:
string
|
null
;
bankAddress2
?:
string
|
null
;
bankCity
?:
string
|
null
;
bankCountry
:
string
|
null
;
bankName
:
string
|
null
;
bankPostalCode
?:
string
|
null
;
bankStateProvinceRegion
?:
string
|
null
;
currency
:
string
|
null
;
message
?:
string
|
null
;
qr
?:
{
base64Image
:
...
;
expirationDate
:
...
;
qrDecoded
:
...
}
|
null
;
reference
:
string
|
null
;
routingCode
:
string
|
null
;
routingCodeAlternate
?:
string
|
null
;
swiftBic
:
string
|
null
;
taxNumber
?:
string
|
null
;
type
:
string
|
null
;
}
|
null
;
programId
:
string
;
provider
:
"ROUTE_FUSION"
;
walletId
:
string
;
}
|
null
;
deletedAt
:
Date
|
null
;
id
:
string
;
name
:
string
|
null
;
providerDepositInstructions
:
ProviderDepositInstructions
|
null
;
providerId
:
string
;
providerName
:
string
;
providerType
:
"ROUTE_FUSION"
|
"VICTOR"
|
"BIVO"
|
"MANUAL"
;
referenceId
:
string
|
null
;
routingNumber
:
string
;
rtpDepositInstructions
:
RtpDepositInstructions
|
null
;
status
:
"ACTIVE"
|
"FAILED"
|
"PENDING"
|
"INACTIVE"
;
swiftDepositInstructions
:
|
(
|
Omit
<
UsdSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
|
Omit
<
ForeignSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
)
[]
|
null
;
type
:
"US_DDA"
|
"US_DEPOSIT"
;
updatedAt
:
Date
;
walletAddress
:
Address
;
wireDepositInstructions
:
UsWireDepositInstructions
|
null
;
}
&
{
customerId
:
string
;
entityId
:
string
;
ledgerAccountId
:
string
}
;
}
,
>
Parameters
args
:
{
customerId
:
string
;
id
:
string
;
name
?:
string
|
null
;
referenceId
?:
string
|
null
;
}
Returns
Promise
<
|
{
error
:
ServiceError
;
ok
:
false
}
|
{
ok
:
true
;
value
:
{
accountNumber
:
string
;
achDepositInstructions
:
AchDepositInstructions
|
null
;
createdAt
:
Date
;
data
:
|
{
provider
:
"VICTOR"
;
victorId
:
string
;
victorLedgerProgramId
:
string
;
}
|
{
entityId
:
string
;
entityInput
?:
{
businessAddress1
:
string
;
businessAddress2
?:
string
;
businessCity
:
string
;
businessCountry
:
string
;
businessName
:
string
;
businessPostalCode
:
string
;
businessStateProvinceRegion
?:
string
;
businessType
?:
|
"b_corporation"
|
"c_corporation"
|
"close_corporation"
|
"cooperative"
|
"general_partnership"
|
"limited_liability_company"
|
"limited_partnership"
|
"nonprofit_corporation"
|
"s_corporation"
|
"sole_proprietorship"
|
"non_us"
;
contactFirstName
:
string
;
contactLastName
:
string
;
email
:
string
;
incorporationDate
?:
string
;
phone
?:
string
;
phoneCountry
?:
string
;
taxNumber
?:
string
;
websiteUrl
?:
string
;
}
;
fundingInstructions
:
|
{
accountHolderAddress1
?:
string
|
null
;
accountHolderAddress2
?:
string
|
null
;
accountHolderCity
?:
string
|
null
;
accountHolderCountry
?:
string
|
null
;
accountHolderName
:
string
|
null
;
accountHolderPostalCode
?:
string
|
null
;
accountHolderStateProvinceRegion
?:
string
|
null
;
accountNumber
:
string
|
null
;
bankAddress1
?:
string
|
null
;
bankAddress2
?:
string
|
null
;
bankCity
?:
string
|
null
;
bankCountry
:
string
|
null
;
bankName
:
string
|
null
;
bankPostalCode
?:
string
|
null
;
bankStateProvinceRegion
?:
string
|
null
;
currency
:
string
|
null
;
message
?:
string
|
null
;
qr
?:
{
base64Image
:
...
;
expirationDate
:
...
;
qrDecoded
:
...
}
|
null
;
reference
:
string
|
null
;
routingCode
:
string
|
null
;
routingCodeAlternate
?:
string
|
null
;
swiftBic
:
string
|
null
;
taxNumber
?:
string
|
null
;
type
:
string
|
null
;
}
|
null
;
programId
:
string
;
provider
:
"ROUTE_FUSION"
;
walletId
:
string
;
}
|
null
;
deletedAt
:
Date
|
null
;
id
:
string
;
name
:
string
|
null
;
providerDepositInstructions
:
ProviderDepositInstructions
|
null
;
providerId
:
string
;
providerName
:
string
;
providerType
:
"ROUTE_FUSION"
|
"VICTOR"
|
"BIVO"
|
"MANUAL"
;
referenceId
:
string
|
null
;
routingNumber
:
string
;
rtpDepositInstructions
:
RtpDepositInstructions
|
null
;
status
:
"ACTIVE"
|
"FAILED"
|
"PENDING"
|
"INACTIVE"
;
swiftDepositInstructions
:
|
(
|
Omit
<
UsdSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
|
Omit
<
ForeignSwiftWireInstructionData
,
"swiftField70Prefix"
>
&
{
receivingEntityName
:
string
;
swiftField70
:
SwiftField70Prefix
;
}
)
[]
|
null
;
type
:
"US_DDA"
|
"US_DEPOSIT"
;
updatedAt
:
Date
;
walletAddress
:
Address
;
wireDepositInstructions
:
UsWireDepositInstructions
|
null
;
}
&
{
customerId
:
string
;
entityId
:
string
;
ledgerAccountId
:
string
}
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
delete
update
@cfxlabsinc/b2b-services
Loading...