@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/clients
metcap
MetcapAccountClient
Class MetcapAccountClient
Hierarchy
MetcapBaseClient
MetcapAccountClient
Index
Constructors
constructor
Properties
client
Methods
get
Account
Balance
get
Account
Transactions
get
Tokens
ping
Constructors
constructor
new
MetcapAccountClient
(
args
:
{
apiUsername
:
string
;
apiUserPassword
:
string
;
bankUsername
:
string
;
bankUserPassword
:
string
;
baseUrl
:
string
;
}
,
)
:
MetcapAccountClient
Parameters
args
:
{
apiUsername
:
string
;
apiUserPassword
:
string
;
bankUsername
:
string
;
bankUserPassword
:
string
;
baseUrl
:
string
;
}
Returns
MetcapAccountClient
Properties
Protected
client
client
:
Client
<
paths
>
Methods
get
Account
Balance
getAccountBalance
(
args
:
{
accountNumber
:
string
;
apiUserToken
:
string
;
bankUserToken
:
string
;
}
,
)
:
Promise
<
{
balance
?:
number
;
error
?:
{
code
?:
|
"TimedOut"
|
"InvalidAccount"
|
"InvalidTransferId"
|
"MissingUsername"
|
"DuplicateUser"
|
"InvalidUserCredentials"
|
"InternalError"
|
"InvalidToken"
|
"TokenExpired"
|
"MissingPassword"
|
"Q2Error"
;
description
?:
string
;
}
;
}
,
>
Parameters
args
:
{
accountNumber
:
string
;
apiUserToken
:
string
;
bankUserToken
:
string
}
Returns
Promise
<
{
balance
?:
number
;
error
?:
{
code
?:
|
"TimedOut"
|
"InvalidAccount"
|
"InvalidTransferId"
|
"MissingUsername"
|
"DuplicateUser"
|
"InvalidUserCredentials"
|
"InternalError"
|
"InvalidToken"
|
"TokenExpired"
|
"MissingPassword"
|
"Q2Error"
;
description
?:
string
;
}
;
}
,
>
get
Account
Transactions
getAccountTransactions
(
args
:
{
accountNumber
:
string
;
apiUserToken
:
string
;
bankUserToken
:
string
;
fromDate
?:
Date
;
pageNumber
?:
number
;
pageSize
?:
number
;
toDate
?:
Date
;
}
,
)
:
Promise
<
{
count
:
number
;
error
?:
{
code
?:
|
"TimedOut"
|
"InvalidAccount"
|
"InvalidTransferId"
|
"MissingUsername"
|
"DuplicateUser"
|
"InvalidUserCredentials"
|
"InternalError"
|
"InvalidToken"
|
"TokenExpired"
|
"MissingPassword"
|
"Q2Error"
;
description
?:
string
;
}
;
returned
?:
number
;
transactions
:
MetcapAccountClientTransaction
[]
;
}
,
>
Parameters
args
:
{
accountNumber
:
string
;
apiUserToken
:
string
;
bankUserToken
:
string
;
fromDate
?:
Date
;
pageNumber
?:
number
;
pageSize
?:
number
;
toDate
?:
Date
;
}
Returns
Promise
<
{
count
:
number
;
error
?:
{
code
?:
|
"TimedOut"
|
"InvalidAccount"
|
"InvalidTransferId"
|
"MissingUsername"
|
"DuplicateUser"
|
"InvalidUserCredentials"
|
"InternalError"
|
"InvalidToken"
|
"TokenExpired"
|
"MissingPassword"
|
"Q2Error"
;
description
?:
string
;
}
;
returned
?:
number
;
transactions
:
MetcapAccountClientTransaction
[]
;
}
,
>
get
Tokens
getTokens
()
:
Promise
<
{
apiUserToken
:
string
;
bankUserToken
:
string
;
expiresAt
:
Date
}
,
>
Returns
Promise
<
{
apiUserToken
:
string
;
bankUserToken
:
string
;
expiresAt
:
Date
}
>
ping
ping
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
Methods
get
Account
Balance
get
Account
Transactions
get
Tokens
ping
@cfxlabsinc/b2b-services
Loading...