@cfxlabsinc/b2b-services
Preparing search index...
@cfxlabsinc/withdrawal-services
yellowcard
YellowcardWithdrawalQuoteService
Class YellowcardWithdrawalQuoteService
Hierarchy (
View Summary
)
YellowcardWithdrawalQuoteQueryService
YellowcardWithdrawalQuoteService
Index
Constructors
constructor
Properties
yellowcard
Client
Methods
accept
create
get
get
Channels
get
Networks
Constructors
constructor
new
YellowcardWithdrawalQuoteService
(
args
:
{
aiPriseClient
:
AiPriseClient
;
B2B_TEMPORAL_WORKER_TASK_QUEUE
:
string
;
entityProductFeeService
:
EntityProductFeeService
;
entityProductService
:
EntityProductService
;
identityQueryService
:
IdentityQueryService
;
paymentInstrumentAdminQueryService
:
PaymentInstrumentAdminQueryService
;
solanaKeypairService
:
SolanaKeypairService
;
solanaNonceService
:
SolanaNonceService
;
solanaTokenService
:
SolanaTokenService
;
solanaTransactionService
:
SolanaTransactionService
;
sqlClient
:
Sql
;
temporalClient
:
Client
;
withdrawalAdminService
:
WithdrawalAdminService
;
withdrawalProductUsageService
:
WithdrawalProductUsageService
;
withdrawalQuoteService
:
WithdrawalQuoteService
;
yellowcardClient
:
YellowcardClient
;
}
,
)
:
YellowcardWithdrawalQuoteService
Parameters
args
:
{
aiPriseClient
:
AiPriseClient
;
B2B_TEMPORAL_WORKER_TASK_QUEUE
:
string
;
entityProductFeeService
:
EntityProductFeeService
;
entityProductService
:
EntityProductService
;
identityQueryService
:
IdentityQueryService
;
paymentInstrumentAdminQueryService
:
PaymentInstrumentAdminQueryService
;
solanaKeypairService
:
SolanaKeypairService
;
solanaNonceService
:
SolanaNonceService
;
solanaTokenService
:
SolanaTokenService
;
solanaTransactionService
:
SolanaTransactionService
;
sqlClient
:
Sql
;
temporalClient
:
Client
;
withdrawalAdminService
:
WithdrawalAdminService
;
withdrawalProductUsageService
:
WithdrawalProductUsageService
;
withdrawalQuoteService
:
WithdrawalQuoteService
;
yellowcardClient
:
YellowcardClient
;
}
Returns
YellowcardWithdrawalQuoteService
Properties
Protected
Readonly
yellowcard
Client
yellowcardClient
:
YellowcardClient
Methods
accept
accept
(
args
:
{
customerId
:
string
;
quoteId
:
string
;
signedTransaction
:
string
}
,
)
:
Promise
<
|
{
ok
:
true
;
value
:
{
withdrawalId
:
string
}
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
Parameters
args
:
{
customerId
:
string
;
quoteId
:
string
;
signedTransaction
:
string
}
Returns
Promise
<
|
{
ok
:
true
;
value
:
{
withdrawalId
:
string
}
}
|
{
error
:
ServiceError
;
ok
:
false
}
,
>
create
create
(
args
:
Pick
<
YellowcardWithdrawalQuote
,
"entityId"
|
"deviceIpAddress"
|
"deviceLocation"
,
>
&
{
channelId
?:
string
;
country
:
string
;
customerId
:
string
;
kyc
?:
{
address
:
string
;
country
:
string
;
dob
:
string
;
email
:
string
;
idNumber
:
string
;
idType
:
string
;
name
:
string
;
phone
:
string
;
}
;
reason
:
|
"other"
|
"gift"
|
"bills"
|
"groceries"
|
"travel"
|
"health"
|
"entertainment"
|
"housing"
|
"school/fees"
;
sourceAmount
:
BigNumber
;
sourceWalletAddress
:
string
;
targetCurrency
:
string
;
targetPaymentInstrument
:
string
;
withdrawalType
:
"bank"
|
"momo"
;
}
,
)
:
Promise
<
|
{
ok
:
true
;
value
:
YellowcardWithdrawalQuote
}
|
{
error
:
|
ServiceError
<
"ENTITY_NOT_FOUND"
|
"NO_COUNTRY"
>
|
ServiceError
<
"PRODUCT_INACTIVE"
|
"PRODUCT_BLOCKED"
>
|
ServiceError
<
"LIMIT_EXCEEDED"
,
ProductLimitViolation
>
|
ServiceError
<
"UNSUPPORTED_COUNTRY"
|
"UNSUPPORTED_PRODUCT"
>
|
ServiceError
<
"IDENTITY_NOT_ACTIVE"
|
"IDENTITY_MISSING_NAME"
>
|
ServiceError
<
"NO_AVAILABLE_CHANNELS"
|
"CHANNEL_NOT_AVAILABLE"
>
|
ServiceError
<
"AMOUNT_BELOW_MINIMUM"
|
"AMOUNT_ABOVE_MAXIMUM"
>
|
ServiceError
<
"INVALID_INSTRUMENT"
>
|
ServiceError
<
"INSUFFICIENT_FUNDS"
,
{
amount
:
BigNumber
;
currency
:
string
}
,
>
;
ok
:
false
;
}
,
>
Parameters
args
:
Pick
<
YellowcardWithdrawalQuote
,
"entityId"
|
"deviceIpAddress"
|
"deviceLocation"
,
>
&
{
channelId
?:
string
;
country
:
string
;
customerId
:
string
;
kyc
?:
{
address
:
string
;
country
:
string
;
dob
:
string
;
email
:
string
;
idNumber
:
string
;
idType
:
string
;
name
:
string
;
phone
:
string
;
}
;
reason
:
|
"other"
|
"gift"
|
"bills"
|
"groceries"
|
"travel"
|
"health"
|
"entertainment"
|
"housing"
|
"school/fees"
;
sourceAmount
:
BigNumber
;
sourceWalletAddress
:
string
;
targetCurrency
:
string
;
targetPaymentInstrument
:
string
;
withdrawalType
:
"bank"
|
"momo"
;
}
Returns
Promise
<
|
{
ok
:
true
;
value
:
YellowcardWithdrawalQuote
}
|
{
error
:
|
ServiceError
<
"ENTITY_NOT_FOUND"
|
"NO_COUNTRY"
>
|
ServiceError
<
"PRODUCT_INACTIVE"
|
"PRODUCT_BLOCKED"
>
|
ServiceError
<
"LIMIT_EXCEEDED"
,
ProductLimitViolation
>
|
ServiceError
<
"UNSUPPORTED_COUNTRY"
|
"UNSUPPORTED_PRODUCT"
>
|
ServiceError
<
"IDENTITY_NOT_ACTIVE"
|
"IDENTITY_MISSING_NAME"
>
|
ServiceError
<
"NO_AVAILABLE_CHANNELS"
|
"CHANNEL_NOT_AVAILABLE"
>
|
ServiceError
<
"AMOUNT_BELOW_MINIMUM"
|
"AMOUNT_ABOVE_MAXIMUM"
>
|
ServiceError
<
"INVALID_INSTRUMENT"
>
|
ServiceError
<
"INSUFFICIENT_FUNDS"
,
{
amount
:
BigNumber
;
currency
:
string
}
,
>
;
ok
:
false
;
}
,
>
get
get
(
__namedParameters
:
{
customerId
:
string
;
id
:
string
;
tx
?:
B2bPgTransaction
;
}
,
)
:
Promise
<
{
ok
:
true
;
value
:
YellowcardWithdrawalQuote
|
null
}
>
Parameters
__namedParameters
:
{
customerId
:
string
;
id
:
string
;
tx
?:
B2bPgTransaction
}
Returns
Promise
<
{
ok
:
true
;
value
:
YellowcardWithdrawalQuote
|
null
}
>
get
Channels
getChannels
(
country
?:
string
)
:
Promise
<
YellowcardChannel
[]
>
Parameters
Optional
country
:
string
Returns
Promise
<
YellowcardChannel
[]
>
get
Networks
getNetworks
(
country
:
string
,
)
:
Promise
<
{
accountNumberType
:
string
;
channelIds
:
string
[]
;
code
?:
string
;
country
:
string
;
id
:
string
;
name
:
string
;
status
:
string
;
}
[]
,
>
Parameters
country
:
string
Returns
Promise
<
{
accountNumberType
:
string
;
channelIds
:
string
[]
;
code
?:
string
;
country
:
string
;
id
:
string
;
name
:
string
;
status
:
string
;
}
[]
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
yellowcard
Client
Methods
accept
create
get
get
Channels
get
Networks
@cfxlabsinc/b2b-services
Loading...