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

    Interface CreateBarcodeRequest

    interface CreateBarcodeRequest {
        amount?: number;
        amountMatchType?: 0 | 1 | 2;
        barcodePaymentType?: 0 | 1 | 2 | 3;
        barcodeType?: 0 | 1 | 2 | 3 | 4;
        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;
        retailerKey?: number;
        senderAddress?: string;
        senderCustomerRef?: string;
        senderEmail?: string;
        senderFirstName?: string;
        senderLastName?: string;
        senderPhone?: string;
        senderZipcode?: string;
    }
    Index

    Properties

    amount? amountMatchType? barcodePaymentType? barcodeType? notificationChannelType? partnerTransactionReference? recipientAddress? recipientCustomerRef? recipientEmail? recipientFirstName? recipientLastName? recipientPhone? recipientZipcode? retailerKey? senderAddress? senderCustomerRef? senderEmail? senderFirstName? senderLastName? senderPhone? senderZipcode?

    Properties

    amount?: number

    Format: double

    Amount for which the barcode is being generated

    amountMatchType?: 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.

    barcodePaymentType?: 0 | 1 | 2 | 3

    Format: int32

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

    barcodeType?: 0 | 1 | 2 | 3 | 4

    Format: int32

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

    notificationChannelType?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

    Format: int32

    0 - none, 1 - SMS, 2 - Email

    partnerTransactionReference?: 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.

    recipientAddress?: string

    address of the recipient

    recipientCustomerRef?: 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.

    recipientEmail?: string

    Email address of the recipient

    recipientFirstName?: string

    First Name of the target account

    recipientLastName?: string

    Last Name of the target account

    recipientPhone?: string

    phone number of the recipient

    recipientZipcode?: string

    Zip code of the sender

    retailerKey?: number

    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 RetailerKeys to the consumer of the API

    senderAddress?: string

    address of the sender

    senderCustomerRef?: 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.

    senderEmail?: string

    Email address of the sender

    senderFirstName?: string

    First Name of the sender

    senderLastName?: string

    Last Name of the sender

    senderPhone?: string

    phone number of the sender

    senderZipcode?: string

    Zip code of the sender

    Settings

    Member Visibility

    On This Page

    Properties