@sumup/sdk
    Preparing search index...

    Type Alias Affiliate

    Affiliate metadata for the transaction. It is an optional field that allow for integrators to track the source of the transaction.

    type Affiliate = {
        app_id: string;
        foreign_transaction_id: string;
        key: string;
        tags?: Record<string, unknown>;
    }
    Index

    Properties

    app_id foreign_transaction_id key tags?

    Properties

    app_id: string

    Application ID of the affiliate. It is a unique identifier for the application and should be set by the integrator in the Affiliate Keys page.

    foreign_transaction_id: string

    Foreign transaction ID of the affiliate. It is a unique identifier for the transaction. It can be used later to fetch the transaction details via the Transactions API.

    key: string

    Key of the affiliate. It is a unique identifier for the key and should be generated by the integrator in the Affiliate Keys page.

    tags?: Record<string, unknown>

    Additional metadata for the transaction. It is key-value object that can be associated with the transaction.

    Settings

    Member Visibility

    On This Page

    Properties