@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/clients
victor
VictorCounterpartyClient
Class VictorCounterpartyClient
Hierarchy
VictorBaseClient
VictorCounterpartyClient
Index
Constructors
constructor
Properties
client
Methods
create
Ach
Counterparty
create
Instant
Payment
Counterparty
create
Us
Wire
Counterparty
delete
Counterparty
get
Bank
Instant
Payment
Elligibility
get
Bank
Name
get
Token
update
Ach
Counterparty
update
Instant
Payment
Counterparty
update
Us
Wire
Counterparty
Constructors
constructor
new
VictorCounterpartyClient
(
args
:
{
baseUrl
:
string
;
clientId
:
string
;
clientSecret
:
string
;
keyvStore
?:
KeyvStoreAdapter
;
proxy
:
{
cert
:
string
;
key
:
string
;
uri
:
string
}
|
null
;
}
,
)
:
VictorCounterpartyClient
Parameters
args
:
{
baseUrl
:
string
;
clientId
:
string
;
clientSecret
:
string
;
keyvStore
?:
KeyvStoreAdapter
;
proxy
:
{
cert
:
string
;
key
:
string
;
uri
:
string
}
|
null
;
}
Returns
VictorCounterpartyClient
Properties
Protected
Readonly
client
client
:
Client
<
paths
>
Methods
create
Ach
Counterparty
createAchCounterparty
(
args
:
{
accountNumber
:
string
;
accountType
:
"CHECKING"
|
"SAVING"
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
args
:
{
accountNumber
:
string
;
accountType
:
"CHECKING"
|
"SAVING"
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
create
Instant
Payment
Counterparty
createInstantPaymentCounterparty
(
args
:
{
accountNumber
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
args
:
{
accountNumber
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
create
Us
Wire
Counterparty
createUsWireCounterparty
(
args
:
{
accountNumber
:
string
;
addressOnAccount
:
{
city
:
string
;
countryCode
:
string
;
line1
:
string
;
line2
?:
string
;
postalCode
:
string
;
region
:
string
;
}
;
bankAddress
:
{
city
:
string
;
line1
:
string
;
postalCode
:
string
;
state
:
string
;
}
;
bankName
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
args
:
{
accountNumber
:
string
;
addressOnAccount
:
{
city
:
string
;
countryCode
:
string
;
line1
:
string
;
line2
?:
string
;
postalCode
:
string
;
region
:
string
;
}
;
bankAddress
:
{
city
:
string
;
line1
:
string
;
postalCode
:
string
;
state
:
string
;
}
;
bankName
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
delete
Counterparty
deleteCounterparty
(
__namedParameters
:
{
victorCounterpartyId
:
string
}
,
)
:
Promise
<
{
deleted_at
?:
number
;
victor_counterparty_id
?:
string
}
>
Parameters
__namedParameters
:
{
victorCounterpartyId
:
string
}
Returns
Promise
<
{
deleted_at
?:
number
;
victor_counterparty_id
?:
string
}
>
get
Bank
Instant
Payment
Elligibility
getBankInstantPaymentElligibility
(
args
:
{
routingNumber
:
string
}
,
)
:
Promise
<
{
bank_name
?:
string
;
fed_now
?:
{
enabled
?:
boolean
;
services_available
?:
{
request_for_payment
?:
boolean
;
send_payment
?:
boolean
;
}
;
}
;
routing_number
?:
unknown
;
rtp
?:
{
enabled
?:
boolean
;
services_available
?:
{
credit_request
?:
boolean
;
request_for_payment
?:
boolean
;
request_refund
?:
boolean
;
send_payment
?:
boolean
;
}
;
}
;
}
,
>
Parameters
args
:
{
routingNumber
:
string
}
Returns
Promise
<
{
bank_name
?:
string
;
fed_now
?:
{
enabled
?:
boolean
;
services_available
?:
{
request_for_payment
?:
boolean
;
send_payment
?:
boolean
;
}
;
}
;
routing_number
?:
unknown
;
rtp
?:
{
enabled
?:
boolean
;
services_available
?:
{
credit_request
?:
boolean
;
request_for_payment
?:
boolean
;
request_refund
?:
boolean
;
send_payment
?:
boolean
;
}
;
}
;
}
,
>
get
Bank
Name
getBankName
(
args
:
{
routingNumber
:
string
;
type
:
"ach"
|
"wire"
}
,
)
:
Promise
<
string
|
undefined
>
check if bank can recieve instant payments
Parameters
args
:
{
routingNumber
:
string
;
type
:
"ach"
|
"wire"
}
Returns
Promise
<
string
|
undefined
>
Protected
get
Token
getToken
()
:
Promise
<
VictorOauthToken
>
Returns
Promise
<
VictorOauthToken
>
update
Ach
Counterparty
updateAchCounterparty
(
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
accountType
:
"CHECKING"
|
"SAVING"
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
>
;
victorCounterpartyId
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
accountType
:
"CHECKING"
|
"SAVING"
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
>
;
victorCounterpartyId
:
string
;
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
update
Instant
Payment
Counterparty
updateInstantPaymentCounterparty
(
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
>
;
victorCounterpartyId
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
}
,
>
;
victorCounterpartyId
:
string
;
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
update
Us
Wire
Counterparty
updateUsWireCounterparty
(
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
addressOnAccount
:
{
city
:
string
;
countryCode
:
string
;
line1
:
string
;
line2
?:
string
;
postalCode
:
string
;
region
:
string
;
}
;
bankAddress
:
{
city
:
string
;
line1
:
string
;
postalCode
:
string
;
state
:
string
;
}
;
bankName
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
>
;
victorCounterpartyId
:
string
;
}
,
)
:
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Parameters
__namedParameters
:
{
data
:
Partial
<
{
accountNumber
:
string
;
addressOnAccount
:
{
city
:
string
;
countryCode
:
string
;
line1
:
string
;
line2
?:
string
;
postalCode
:
string
;
region
:
string
;
}
;
bankAddress
:
{
city
:
string
;
line1
:
string
;
postalCode
:
string
;
state
:
string
;
}
;
bankName
:
string
;
nameOnAccount
:
string
;
routingNumber
:
string
;
}
,
>
;
victorCounterpartyId
:
string
;
}
Returns
Promise
<
{
account_name
?:
string
;
address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
counterparty_ach_info
?:
{
account_number
?:
string
;
account_type
?:
"CHECKING"
|
"SAVING"
|
"GL"
;
routing_number
?:
string
;
}
;
counterparty_rtp_info
?:
{
account_number
?:
string
;
routing_number
?:
string
;
}
;
counterparty_wire_info
?:
{
account_number
?:
string
;
address_on_account
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_address
?:
{
city
:
string
;
country_code
?:
string
;
state
:
string
;
street_address1
:
string
;
street_address2
?:
string
;
zip_code
:
string
;
}
;
bank_name
?:
string
;
intermediary_bank_name
?:
string
;
intermediary_bank_routing_number
?:
string
;
routing_number
?:
string
;
}
;
created_at
?:
number
;
description
?:
string
;
updated_at
?:
number
;
victor_counterparty_id
?:
string
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
Methods
create
Ach
Counterparty
create
Instant
Payment
Counterparty
create
Us
Wire
Counterparty
delete
Counterparty
get
Bank
Instant
Payment
Elligibility
get
Bank
Name
get
Token
update
Ach
Counterparty
update
Instant
Payment
Counterparty
update
Us
Wire
Counterparty
@cfxlabsinc/b2b-services
Loading...
check if bank can recieve instant payments