MarzPay SDK Reference - v1.0.3
    Preparing search index...

    Interface CreateCollectionParams

    interface CreateCollectionParams {
        amount: number;
        callback_url?: string;
        country: CountryCode;
        currency?: CurrencyCode;
        description?: string;
        metadata?: MetadataItem[];
        method?: CollectionMethod;
        phone_number?: string;
        reference?: string;
    }
    Index
    amount callback_url? country currency? description? metadata? method? phone_number? reference?
    amount: number

    Collection amount

    callback_url?: string

    HTTPS webhook URL to receive payment status update

    country: CountryCode

    Market country code

    currency?: CurrencyCode

    Currency code (For DRC: CDF or USD)

    description?: string

    Optional transaction description (max 255 chars)

    metadata?: MetadataItem[]

    Up to 10 metadata key-value items

    method?: CollectionMethod

    Payment method: 'mobile_money' (default) or 'card'

    phone_number?: string

    Phone number in E.164 format (e.g. +256712345678). Required for mobile_money.

    reference?: string

    Unique UUID reference per collection request. Auto-generated as a valid v4 UUID if omitted.

    Settings
    Member Visibility

    On This Page
    Properties