@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/payment-instrument-services
UsInstantPaymentInstrumentService
Class UsInstantPaymentInstrumentService
Maintain the account details for sending payments via Automated Clearing House.
Index
Constructors
constructor
Methods
create
delete
update
Constructors
constructor
new
UsInstantPaymentInstrumentService
(
args
:
{
customerService
:
CustomerService
;
entityEventPublisher
:
EntityEventPublisher
;
entityService
:
EntityService
;
sqlClient
:
Sql
;
victorCounterpartyClient
:
VictorCounterpartyClient
;
}
,
)
:
UsInstantPaymentInstrumentService
Parameters
args
:
{
customerService
:
CustomerService
;
entityEventPublisher
:
EntityEventPublisher
;
entityService
:
EntityService
;
sqlClient
:
Sql
;
victorCounterpartyClient
:
VictorCounterpartyClient
;
}
Returns
UsInstantPaymentInstrumentService
Methods
create
create
(
input
:
Input
,
)
:
Promise
<
|
{
error
:
|
ServiceError
<
"INVALID_ENTITY"
>
|
ServiceError
<
"DUPLICATE"
>
|
ServiceError
<
"INVALID_BANK"
>
;
ok
:
false
;
}
|
{
ok
:
true
;
value
:
{
accountHolderName
:
string
;
accountNumber
:
string
;
createdAt
:
Date
;
deletedAt
:
Date
|
null
;
id
:
string
;
provider
:
|
"REDEMPTION"
|
"SOLANA"
|
"MX_CLABE"
|
"WIRE_DEPOSIT"
|
"ACH_PUSH_DEPOSIT"
|
"YELLOWCARD"
|
"QUILTT"
|
"VICTOR"
|
"CFX"
|
"ETHEREUM"
|
"BASE"
;
providerId
:
string
;
referenceId
?:
string
;
routingNumber
:
string
;
status
:
"ACTIVE"
|
"PENDING_VERIFICATION"
|
"BLOCKED"
|
"DELETED"
;
type
:
"US_INSTANT"
;
updatedAt
:
Date
;
victorCounterpartyId
?:
string
;
}
;
}
,
>
Parameters
input
:
Input
Returns
Promise
<
|
{
error
:
|
ServiceError
<
"INVALID_ENTITY"
>
|
ServiceError
<
"DUPLICATE"
>
|
ServiceError
<
"INVALID_BANK"
>
;
ok
:
false
;
}
|
{
ok
:
true
;
value
:
{
accountHolderName
:
string
;
accountNumber
:
string
;
createdAt
:
Date
;
deletedAt
:
Date
|
null
;
id
:
string
;
provider
:
|
"REDEMPTION"
|
"SOLANA"
|
"MX_CLABE"
|
"WIRE_DEPOSIT"
|
"ACH_PUSH_DEPOSIT"
|
"YELLOWCARD"
|
"QUILTT"
|
"VICTOR"
|
"CFX"
|
"ETHEREUM"
|
"BASE"
;
providerId
:
string
;
referenceId
?:
string
;
routingNumber
:
string
;
status
:
"ACTIVE"
|
"PENDING_VERIFICATION"
|
"BLOCKED"
|
"DELETED"
;
type
:
"US_INSTANT"
;
updatedAt
:
Date
;
victorCounterpartyId
?:
string
;
}
;
}
,
>
delete
delete
(
__namedParameters
:
{
customerId
:
string
;
entityId
:
string
;
id
:
string
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
undefined
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
Parameters
__namedParameters
:
{
customerId
:
string
;
entityId
:
string
;
id
:
string
}
Returns
Promise
<
{
ok
:
true
;
value
:
undefined
}
|
{
error
:
ServiceError
;
ok
:
false
}
>
update
update
(
input
:
Omit
<
Input
,
"referenceId"
>
&
{
id
:
string
;
referenceId
?:
string
|
null
;
}
,
)
:
Promise
<
|
{
error
:
|
ServiceError
<
"INVALID_ENTITY"
>
|
ServiceError
<
"NOT_FOUND"
|
"DUPLICATE"
>
|
ServiceError
<
"INVALID_BANK"
>
;
ok
:
false
;
}
|
{
ok
:
true
;
value
:
{
accountHolderName
:
string
;
accountNumber
:
string
;
createdAt
:
Date
;
deletedAt
:
Date
|
null
;
id
:
string
;
provider
:
|
"REDEMPTION"
|
"SOLANA"
|
"MX_CLABE"
|
"WIRE_DEPOSIT"
|
"ACH_PUSH_DEPOSIT"
|
"YELLOWCARD"
|
"QUILTT"
|
"VICTOR"
|
"CFX"
|
"ETHEREUM"
|
"BASE"
;
providerId
:
string
;
referenceId
?:
string
;
routingNumber
:
string
;
status
:
"ACTIVE"
|
"PENDING_VERIFICATION"
|
"BLOCKED"
|
"DELETED"
;
type
:
"US_INSTANT"
;
updatedAt
:
Date
;
victorCounterpartyId
?:
string
;
}
;
}
,
>
Parameters
input
:
Omit
<
Input
,
"referenceId"
>
&
{
id
:
string
;
referenceId
?:
string
|
null
}
Returns
Promise
<
|
{
error
:
|
ServiceError
<
"INVALID_ENTITY"
>
|
ServiceError
<
"NOT_FOUND"
|
"DUPLICATE"
>
|
ServiceError
<
"INVALID_BANK"
>
;
ok
:
false
;
}
|
{
ok
:
true
;
value
:
{
accountHolderName
:
string
;
accountNumber
:
string
;
createdAt
:
Date
;
deletedAt
:
Date
|
null
;
id
:
string
;
provider
:
|
"REDEMPTION"
|
"SOLANA"
|
"MX_CLABE"
|
"WIRE_DEPOSIT"
|
"ACH_PUSH_DEPOSIT"
|
"YELLOWCARD"
|
"QUILTT"
|
"VICTOR"
|
"CFX"
|
"ETHEREUM"
|
"BASE"
;
providerId
:
string
;
referenceId
?:
string
;
routingNumber
:
string
;
status
:
"ACTIVE"
|
"PENDING_VERIFICATION"
|
"BLOCKED"
|
"DELETED"
;
type
:
"US_INSTANT"
;
updatedAt
:
Date
;
victorCounterpartyId
?:
string
;
}
;
}
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
delete
update
@cfxlabsinc/b2b-services
Loading...
Maintain the account details for sending payments via Automated Clearing House.