Class YellowcardClient

constructor

• new YellowcardClient(): YellowcardClient

  Returns YellowcardClient

Staticinstance

acceptPaymentRequest

• acceptPaymentRequest(
      id: string,
  ): Promise<
      | { error: YellowcardError; ok: false }
      | { error: ServiceError<"PAYMENT_NOT_FOUND", object>; ok: false }
      | {
          ok: true;
          value: {
              amount: number;
              channelId?: string;
              convertedAmount: number;
              country?: string;
              createdAt?: string;
              currency?: string;
              destination?: {
                  accountName?: string;
                  accountNumber?: string;
                  accountType?: string;
                  networkId?: string;
                  networkName?: string;
              };
              expiresAt?: string;
              id?: string;
              partnerId?: string;
              rate: number;
              reason?: string;
              sender?: {
                  address?: string;
                  country?: string;
                  dob?: string;
                  email?: string;
                  idNumber?: string;
                  idType?: string;
                  name?: string;
                  phone?: string;
              };
              sequenceId?: string;
              status?: string;
              updatedAt?: string;
          };
      },
  >

  Parameters

  • id: string

  Returns Promise<
      | { error: YellowcardError; ok: false }
      | { error: ServiceError<"PAYMENT_NOT_FOUND", object>; ok: false }
      | {
          ok: true;
          value: {
              amount: number;
              channelId?: string;
              convertedAmount: number;
              country?: string;
              createdAt?: string;
              currency?: string;
              destination?: {
                  accountName?: string;
                  accountNumber?: string;
                  accountType?: string;
                  networkId?: string;
                  networkName?: string;
              };
              expiresAt?: string;
              id?: string;
              partnerId?: string;
              rate: number;
              reason?: string;
              sender?: {
                  address?: string;
                  country?: string;
                  dob?: string;
                  email?: string;
                  idNumber?: string;
                  idType?: string;
                  name?: string;
                  phone?: string;
              };
              sequenceId?: string;
              status?: string;
              updatedAt?: string;
          };
      },
  >

createWebhook

• createWebhook(
      req: { active?: boolean; state?: string; url: string } & {} | undefined,
  ): Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              active: boolean;
              createdAt?: string;
              id?: string;
              partnerId?: string;
              state?: string;
              updatedAt?: string;
              url?: string;
          };
      },
  >

  Parameters

  • req: { active?: boolean; state?: string; url: string } & {} | undefined
    • { active?: boolean; state?: string; url: string } & {}

      • Optionalactive?: boolean

        Description

        Whether this webhook is currently active or not. Defaults to true if omitted.

        Default

        true
        Copy

      • Optionalstate?: string

        Description

        The transaction status event that this webhook will be activated for. If omitted, the webhook will receive all events.

      • url: string

        Description

        The URL to which the event will be posted to.
    • undefined

  Returns Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              active: boolean;
              createdAt?: string;
              id?: string;
              partnerId?: string;
              state?: string;
              updatedAt?: string;
              url?: string;
          };
      },
  >

getChannels

• getChannels(
      country?: string,
  ): Promise<
      | { ok: true; value: YellowcardChannel[] }
      | { error: YellowcardError; ok: false },
  >

  Parameters

  • Optionalcountry: string

  Returns Promise<
      | { ok: true; value: YellowcardChannel[] }
      | { error: YellowcardError; ok: false },
  >

getNetworks

• getNetworks(
      country?: string,
  ): Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              accountNumberType?: string;
              channelIds?: string[];
              code?: string;
              country?: string;
              countryAccountNumberType?: string;
              createdAt?: string;
              id?: string;
              name?: string;
              status?: string;
              updatedAt?: string;
          }[];
      },
  >

  Parameters

  • Optionalcountry: string

  Returns Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              accountNumberType?: string;
              channelIds?: string[];
              code?: string;
              country?: string;
              countryAccountNumberType?: string;
              createdAt?: string;
              id?: string;
              name?: string;
              status?: string;
              updatedAt?: string;
          }[];
      },
  >

getRates

• getRates(
      currency?: string,
  ): Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              rates?: {
                  buy: number;
                  code?: string;
                  locale?: string;
                  rateId?: string;
                  sell: number;
                  updatedAt?: string;
              }[];
          };
      },
  >

  Parameters

  • Optionalcurrency: string

  Returns Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              rates?: {
                  buy: number;
                  code?: string;
                  locale?: string;
                  rateId?: string;
                  sell: number;
                  updatedAt?: string;
              }[];
          };
      },
  >

submitPaymentRequest

• submitPaymentRequest(
      req: {
          amount?: number;
          channelId: string;
          customerType?: "retail" | "institution";
          destination: {
              accountBank?: string;
              accountName: string;
              accountNumber: string;
              accountType: "bank" | "momo";
              country?: string;
              networkId: string;
              networkName?: string;
              phoneNumber?: string;
          } & {};
          forceAccept?: boolean;
          localAmount?: number;
          reason: string;
          sender: {
              additionalIdNumber?: string;
              additionalIdType?: string;
              address?: string;
              businessId?: string;
              businessName?: string;
              country?: string;
              dob?: string;
              email?: string;
              idNumber?: string;
              idType?: string;
              name?: string;
              phone?: string;
          } & {};
          sequenceId: string;
      } & {} & { customerUID: string },
  ): Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              amount: number;
              channelId?: string;
              convertedAmount: number;
              country?: string;
              createdAt?: string;
              currency?: string;
              destination?: {
                  accountName?: string;
                  accountNumber?: string;
                  accountType?: string;
                  networkId?: string;
              };
              expiresAt?: string;
              id?: string;
              rate: number;
              reason?: string;
              sender?: {
                  address?: string;
                  country?: string;
                  dob?: string;
                  email?: string;
                  idNumber?: string;
                  idType?: string;
                  name?: string;
                  phone?: string;
              };
              sequenceId?: string;
              status?: string;
              updatedAt?: string;
          };
      },
  >

  Parameters

  • req: {
        amount?: number;
        channelId: string;
        customerType?: "retail" | "institution";
        destination: {
            accountBank?: string;
            accountName: string;
            accountNumber: string;
            accountType: "bank" | "momo";
            country?: string;
            networkId: string;
            networkName?: string;
            phoneNumber?: string;
        } & {};
        forceAccept?: boolean;
        localAmount?: number;
        reason: string;
        sender: {
            additionalIdNumber?: string;
            additionalIdType?: string;
            address?: string;
            businessId?: string;
            businessName?: string;
            country?: string;
            dob?: string;
            email?: string;
            idNumber?: string;
            idType?: string;
            name?: string;
            phone?: string;
        } & {};
        sequenceId: string;
    } & {} & { customerUID: string }

    • Optionalamount?: number

      Format: int32

      Description

      Amount in USD to transact

    • channelId: string

      Description

      The identifier of the specific channel to execute payment through

    • OptionalcustomerType?: "retail" | "institution"

      Description

      Determines the type of validation that is performed on the sender. If value is institution, the sender request object will be validated to ensure it includes businessName and businessId parameter. If the value is retail, the sender request object will be validated to ensure it includes name, phone, email, country, address, dob, idNumber and idType.

      Default

      retail
      @enum {string}
      Copy

    • destination: {
          accountBank?: string;
          accountName: string;
          accountNumber: string;
          accountType: "bank" | "momo";
          country?: string;
          networkId: string;
          networkName?: string;
          phoneNumber?: string;
      } & {}

      Description

      Destination and Recipient Details

    • OptionalforceAccept?: boolean

      Description

      Specify whether or not you want to skip the accept payment step

      Default

      false
      Copy

    • OptionallocalAmount?: number

      Format: int32

      Description

      The amount in local currency to transact

    • reason: string

      Description

      The reason for the withdrawal

    • sender: {
          additionalIdNumber?: string;
          additionalIdType?: string;
          address?: string;
          businessId?: string;
          businessName?: string;
          country?: string;
          dob?: string;
          email?: string;
          idNumber?: string;
          idType?: string;
          name?: string;
          phone?: string;
      } & {}

      Description

      Sender KYC details

    • sequenceId: string

      Description

      Represents a unique id for the transaction from your end

    • customerUID: string

  Returns Promise<
      | { error: YellowcardError; ok: false }
      | {
          ok: true;
          value: {
              amount: number;
              channelId?: string;
              convertedAmount: number;
              country?: string;
              createdAt?: string;
              currency?: string;
              destination?: {
                  accountName?: string;
                  accountNumber?: string;
                  accountType?: string;
                  networkId?: string;
              };
              expiresAt?: string;
              id?: string;
              rate: number;
              reason?: string;
              sender?: {
                  address?: string;
                  country?: string;
                  dob?: string;
                  email?: string;
                  idNumber?: string;
                  idType?: string;
                  name?: string;
                  phone?: string;
              };
              sequenceId?: string;
              status?: string;
              updatedAt?: string;
          };
      },
  >