Class YellowcardWithdrawalQuoteService

Hierarchy (View Summary)

YellowcardWithdrawalQuoteQueryService
- YellowcardWithdrawalQuoteService

Index

Constructors

constructor

new YellowcardWithdrawalQuoteService(
    args: {
        aiPriseClient: AiPriseClient;
        db: B2bDatabase;
        identityQueryService: IdentityQueryService;
        ledgerAccountQueryService: LedgerAccountQueryService;
        organizationQueryService: OrganizationQueryService;
        paymentInstrumentAdminQueryService: PaymentInstrumentAdminQueryService;
        productQuoteService: ProductQuoteService;
        temporalClient: TemporalWorkflowClient<Workflows>;
        withdrawalAdminService: WithdrawalAdminService;
        withdrawalQuoteService: WithdrawalQuoteService;
        yellowcardClient: YellowcardClient;
    },
): YellowcardWithdrawalQuoteService
Parameters
- args: {
      aiPriseClient: AiPriseClient;
      db: B2bDatabase;
      identityQueryService: IdentityQueryService;
      ledgerAccountQueryService: LedgerAccountQueryService;
      organizationQueryService: OrganizationQueryService;
      paymentInstrumentAdminQueryService: PaymentInstrumentAdminQueryService;
      productQuoteService: ProductQuoteService;
      temporalClient: TemporalWorkflowClient<Workflows>;
      withdrawalAdminService: WithdrawalAdminService;
      withdrawalQuoteService: WithdrawalQuoteService;
      yellowcardClient: YellowcardClient;
  }
Returns YellowcardWithdrawalQuoteService
Overrides YellowcardWithdrawalQuoteQueryService.constructor
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:259

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`yellowcardClient

yellowcardClient: YellowcardClient

`Static`instance

instance: (...args: []) => YellowcardWithdrawalQuoteService = ...

The process service, starting workflows on the temporal namespace's queue.

Methods

accept

accept(
    args: { customerId: string; quoteId: string },
): Promise<
    | { ok: true; value: { withdrawalId: string } }
    | { error: ServiceError; ok: false },
>
Accepts a ledger-funded quote; the workflow funds the hold and pays out.
Parameters
- args: { customerId: string; quoteId: string }
Returns Promise<
| { ok: true; value: { withdrawalId: string } }
| { error: ServiceError; ok: false },
>
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:593

create

create(
    args: Pick<
        YellowcardWithdrawalQuote,
        "deviceIpAddress"
        | "deviceLocation"
        | "entityId",
    > & {
        channelId?: string;
        country: string;
        customerId: string;
        idempotencyKey?: string;
        kyc?: SenderKyc;
        reason: YellowcardReason;
        sourceAccountId: string;
        sourceAmount: BigNumber;
        targetCurrency: string;
        targetPaymentInstrument: string;
        withdrawalType: "bank" | "momo";
    },
): Promise<
    | { ok: true; value: YellowcardWithdrawalQuote }
    | {
        error:
            | ServiceError<
                | "INSUFFICIENT_FUNDS"
                | "PRODUCT_INACTIVE"
                | "NO_ELIGIBLE_ROUTE"
                | "CUSTOMER_NOT_ACTIVE"
                | "PAYMENT_INSTRUMENT_BLOCKED"
                | "PAYMENT_INSTRUMENT_ACTION_REQUIRED",
            >
            | ServiceError<"LIMIT_EXCEEDED", ProductLimitViolation>
            | ServiceError<QuoteInvariantViolation>
            | ServiceError<
                "ENTITY_NOT_FOUND"
                | "ENTITY_CANNOT_TRANSACT"
                | "NO_COUNTRY",
            >
            | ServiceError<"UNSUPPORTED_COUNTRY" | "UNSUPPORTED_PRODUCT">
            | ServiceError<"IDENTITY_NOT_ACTIVE">
            | ServiceError<"ORGANIZATION_REGISTRATION_NUMBER_REQUIRED">
            | ServiceError<"LEDGER_ACCOUNT_NOT_FOUND", { id: string }>
            | ServiceError<"NO_AVAILABLE_CHANNELS" | "CHANNEL_NOT_AVAILABLE">
            | ServiceError<"AMOUNT_BELOW_MINIMUM" | "AMOUNT_ABOVE_MAXIMUM">
            | ServiceError<"INVALID_INSTRUMENT">;
        ok: false;
    },
>
Quotes a payout funded from the owner's ledger account. CFX signs the mintfx withdraw hold when the quote is accepted.
Parameters
- args: Pick<
      YellowcardWithdrawalQuote,
      "deviceIpAddress"
      | "deviceLocation"
      | "entityId",
  > & {
      channelId?: string;
      country: string;
      customerId: string;
      idempotencyKey?: string;
      kyc?: SenderKyc;
      reason: YellowcardReason;
      sourceAccountId: string;
      sourceAmount: BigNumber;
      targetCurrency: string;
      targetPaymentInstrument: string;
      withdrawalType: "bank" | "momo";
  }
  - OptionalchannelId?: string
  - country: string
  - customerId: string
  - OptionalidempotencyKey?: string
    
    Caller-supplied idempotency key (from the API Idempotency-Key header). Threaded into productQuoteService.quote() (dedupes the pinned engine quote) and withdrawalQuoteService.create() (dedupes the withdrawal quote). Optional — internal callers don't supply one.
  - Optionalkyc?: SenderKyc
    
    An identity's sender details, in place of its verified profile.
  - reason: YellowcardReason
  - sourceAccountId: string
  - sourceAmount: BigNumber
  - targetCurrency: string
  - targetPaymentInstrument: string
  - withdrawalType: "bank" | "momo"
Returns Promise<
    | { ok: true; value: YellowcardWithdrawalQuote }
    | {
        error:
            | ServiceError<
                | "INSUFFICIENT_FUNDS"
                | "PRODUCT_INACTIVE"
                | "NO_ELIGIBLE_ROUTE"
                | "CUSTOMER_NOT_ACTIVE"
                | "PAYMENT_INSTRUMENT_BLOCKED"
                | "PAYMENT_INSTRUMENT_ACTION_REQUIRED",
            >
            | ServiceError<"LIMIT_EXCEEDED", ProductLimitViolation>
            | ServiceError<QuoteInvariantViolation>
            | ServiceError<
                "ENTITY_NOT_FOUND"
                | "ENTITY_CANNOT_TRANSACT"
                | "NO_COUNTRY",
            >
            | ServiceError<"UNSUPPORTED_COUNTRY" | "UNSUPPORTED_PRODUCT">
            | ServiceError<"IDENTITY_NOT_ACTIVE">
            | ServiceError<"ORGANIZATION_REGISTRATION_NUMBER_REQUIRED">
            | ServiceError<"LEDGER_ACCOUNT_NOT_FOUND", { id: string }>
            | ServiceError<"NO_AVAILABLE_CHANNELS" | "CHANNEL_NOT_AVAILABLE">
            | ServiceError<"AMOUNT_BELOW_MINIMUM" | "AMOUNT_ABOVE_MAXIMUM">
            | ServiceError<"INVALID_INSTRUMENT">;
        ok: false;
    },
>
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:289

estimate

estimate(
    args: {
        country: string;
        customerId: string;
        entityId: string;
        source: { amount: BigNumber };
        targetCurrency: string;
        withdrawalType: "bank" | "momo";
    },
): Promise<
    | { error: ServiceError<string, object>; ok: false }
    | {
        ok: true;
        value: {
            exchangeRate: BigNumber;
            fees: Fees;
            sourceAmount: BigNumber;
            targetAmountAfterFees: BigNumber;
            totalFees: BigNumber;
            withdrawalType: "bank" | "momo";
        };
    },
>
Parameters
- args: {
      country: string;
      customerId: string;
      entityId: string;
      source: { amount: BigNumber };
      targetCurrency: string;
      withdrawalType: "bank" | "momo";
  }
Returns Promise<
    | { error: ServiceError<string, object>; ok: false }
    | {
        ok: true;
        value: {
            exchangeRate: BigNumber;
            fees: Fees;
            sourceAmount: BigNumber;
            targetAmountAfterFees: BigNumber;
            totalFees: BigNumber;
            withdrawalType: "bank" | "momo";
        };
    },
>
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:887

get

get(
    __namedParameters: {
        customerId: string;
        id: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<{ ok: true; value: YellowcardWithdrawalQuote | null }>
Parameters
- __namedParameters: {
      customerId: string;
      id: string;
      tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
  }
Returns Promise<{ ok: true; value: YellowcardWithdrawalQuote | null }>
Inherited from YellowcardWithdrawalQuoteQueryService.get
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:135

getChannels

getChannels(country?: string): Promise<YellowcardChannel[]>
Parameters
- Optionalcountry: string
Returns Promise<YellowcardChannel[]>
Inherited from YellowcardWithdrawalQuoteQueryService.getChannels
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:168

getNetworks

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;
    }[],
>
Inherited from YellowcardWithdrawalQuoteQueryService.getNetworks
- Defined in packages/withdrawal-services/src/yellowcard/YellowcardWithdrawalQuoteService.ts:174

Class YellowcardWithdrawalQuoteService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns YellowcardWithdrawalQuoteService

Properties

Protected Readonlydb

Protected ReadonlyyellowcardClient

Staticinstance

Methods

accept

Parameters

Returns Promise< | { ok: true; value: { withdrawalId: string } } | { error: ServiceError; ok: false },>

create

Parameters

OptionalchannelId?: string

country: string

customerId: string

OptionalidempotencyKey?: string

Optionalkyc?: SenderKyc

reason: YellowcardReason

sourceAccountId: string

sourceAmount: BigNumber

targetCurrency: string

targetPaymentInstrument: string

withdrawalType: "bank" | "momo"

estimate

Parameters

Returns Promise< | { error: ServiceError<string, object>; ok: false } | { ok: true; value: { exchangeRate: BigNumber; fees: Fees; sourceAmount: BigNumber; targetAmountAfterFees: BigNumber; totalFees: BigNumber; withdrawalType: "bank" | "momo"; }; },>

get

Parameters

Returns Promise<{ ok: true; value: YellowcardWithdrawalQuote | null }>

getChannels

Parameters

Returns Promise<YellowcardChannel[]>

getNetworks

Parameters

Returns Promise< { accountNumberType: string; channelIds: string[]; code?: string; country: string; id: string; name: string; status: string; }[],>

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`yellowcardClient

`Static`instance

Returns Promise<
| { ok: true; value: { withdrawalId: string } }
| { error: ServiceError; ok: false },
>

`Optional`channelId?: string

`Optional`idempotencyKey?: string

`Optional`kyc?: SenderKyc

Returns Promise<
| { error: ServiceError<string, object>; ok: false }
| {
ok: true;
value: {
exchangeRate: BigNumber;
fees: Fees;
sourceAmount: BigNumber;
targetAmountAfterFees: BigNumber;
totalFees: BigNumber;
withdrawalType: "bank" | "momo";
};
},
>

Returns Promise<
{
accountNumberType: string;
channelIds: string[];
code?: string;
country: string;
id: string;
name: string;
status: string;
}[],
>