@cfxlabsinc/b2b-services
    Preparing search index...

    Class GreendotBarcodeClient

    Hierarchy

    • GreendotBaseClient
      • GreendotBarcodeClient
    Index
    constructor
    client instance
    createBarcode getBarcode getBarcodes ping
    client: Client<paths>
    instance: (...args: []) => GreendotBarcodeClient = ...

    The process client over the partner API, reading greendot-partner at each call.

    • Mints a barcode. BARCODE_LIMIT_EXCEEDED when Green Dot refuses for the load limit or the barcode velocity limit.

      Parameters

      • req: {
            amount?: number;
            amountMatchType?: 0 | 1 | 2;
            barcodePaymentType?: 0 | 1 | 2 | 3;
            barcodeType?: 0 | 1 | 2 | 3 | 4;
            ipAddress?: string;
            latitude?: string;
            longitude?: string;
            notificationChannelType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7;
            partnerTransactionReference?: string;
            recipientAddress?: string;
            recipientCustomerRef?: string;
            recipientEmail?: string;
            recipientFirstName?: string;
            recipientLastName?: string;
            recipientPhone?: string;
            recipientZipcode?: string;
            retailerId: string;
            senderAddress?: string;
            senderCustomerRef?: string;
            senderEmail?: string;
            senderFirstName?: string;
            senderLastName?: string;
            senderPhone?: string;
            senderZipcode?: string;
        }
        • Optionalamount?: number

          Format: double

          Amount for which the barcode is being generated

        • OptionalamountMatchType?: 0 | 1 | 2

          Format: int32

          0-No constraint, barcode can be consumed without constraint on amount. 1-Partial consumption, barcode must be consumed less than or equal to the amount specified in amount parameter(Not currently supported). 2-Full consumption, barcode must be consumed with exact amount specified in amount parameter. By default, amount_match_type is 0.

        • OptionalbarcodePaymentType?: 0 | 1 | 2 | 3

          Format: int32

          0-None, 1-Deposit, 2-Payment, 3-Debit

        • OptionalbarcodeType?: 0 | 1 | 2 | 3 | 4

          Format: int32

          1-BarcodeLink, 2-BarcodeForPrint, 3-BarcodeForView, 4-MultiUseBarcode

        • OptionalipAddress?: string
        • Optionallatitude?: string

          Latitude of the customer

        • Optionallongitude?: string

          Longitude of the customer

        • OptionalnotificationChannelType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

          Format: int32

          0 - none, 1 - SMS, 2 - Email

        • OptionalpartnerTransactionReference?: string

          Transaction Reference for the current transaction (eg send money request, etc). This is the reference generated/maintained by Partner. GD will use it for audit purposes.

        • OptionalrecipientAddress?: string

          address of the recipient

        • OptionalrecipientCustomerRef?: string

          Identifier/Reference which the partner generates for the target (/receiver) of this transaction. Eg., If A is trying to send money to B, this is an identifier/ reference of B's account.

        • OptionalrecipientEmail?: string

          Email address of the recipient

        • OptionalrecipientFirstName?: string

          First Name of the target account

        • OptionalrecipientLastName?: string

          Last Name of the target account

        • OptionalrecipientPhone?: string

          phone number of the recipient

        • OptionalrecipientZipcode?: string

          Zip code of the sender

        • retailerId: string

          Format: int32

          Retailer for which the barcode is being generated. The barcode number might be different based on the retailer. GD will provide the list of retailerIds to the consumer of the API

        • OptionalsenderAddress?: string

          address of the sender

        • OptionalsenderCustomerRef?: string

          Identifier/Reference which the partner generates for the source (/sender) of this transaction. Eg., If A is trying to send money to B, this is an identifier/ reference of A's account.

        • OptionalsenderEmail?: string

          Email address of the sender

        • OptionalsenderFirstName?: string

          First Name of the sender

        • OptionalsenderLastName?: string

          Last Name of the sender

        • OptionalsenderPhone?: string

          phone number of the sender

        • OptionalsenderZipcode?: string

          Zip code of the sender

      Returns Promise<
          | {
              ok: true;
              value: {
                  barcodeId: string;
                  barcodeIdExpiration: string;
                  barcodeLink: string
                  | undefined;
                  barcodePaymentType: 0 | 1 | 2 | 3 | undefined;
                  barcodeType: 0 | 1 | 2 | 3 | 4 | undefined;
                  cancelOldest: boolean;
                  expiresAt: string;
                  greendotId: string;
                  id: string;
                  partnerTransactionReference: string | undefined;
                  responseCode: number;
                  responseDate: string;
                  responseMessage: string | undefined;
                  retailerId: string;
                  retailerName: string | undefined;
                  transactionReference: string;
              };
          }
          | { error: GreendotCreateBarcodeError; ok: false },
      >

    • Reads one barcode. null when Green Dot answers BarcodeNotFound. Any other error is a fault here: the caller named a barcode it minted.

      Parameters

      • req: { barcodeId: string; retailerId: string }

      Returns Promise<
          | {
              amount: number
              | undefined;
              barcodeChangeDate: string;
              barcodeId: string | undefined;
              barcodeIdExpiration: string;
              barcodeStatus: number;
              partnerTransactionReference: string | undefined;
              responseCode: number | undefined;
              responseDate: string | undefined;
              responseMessage: string | undefined;
              retailerId: string | undefined;
              retailerName: string | undefined;
              senderCustomerRef: string | undefined;
              status:
                  | "EXPIRED"
                  | "PENDING"
                  | "DECLINED"
                  | "CANCELLED"
                  | "CONSUMED"
                  | "VOIDED"
                  | "NEW";
              transactionReference: string
              | undefined;
          }
          | null,
      >

    • Parameters

      • req: { endDate: Date; senderCustomerRef: string; startDate: Date }

      Returns Promise<
          | {
              ok: true;
              value: {
                  barcodes: {
                      amount: number
                      | undefined;
                      barcodeChangeDate: string | undefined;
                      barcodeId: string | undefined;
                      barcodeIdExpiration: string | undefined;
                      barcodeStatus: number | undefined;
                      retailerId: string | undefined;
                      retailerName: string | undefined;
                      senderCustomerRef: string | undefined;
                      status:
                          | "EXPIRED"
                          | "PENDING"
                          | "DECLINED"
                          | "CANCELLED"
                          | "CONSUMED"
                          | "VOIDED"
                          | "NEW";
                  }[];
                  partnerTransactionReference: string
                  | undefined;
                  responseCode: number | undefined;
                  responseDate: string | undefined;
                  responseMessage: string | undefined;
                  searchCount: number | undefined;
                  transactionReference: string | undefined;
              };
          }
          | { error: GreendotError; ok: false },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods