Typescript SDK Type Docs
    Preparing search index...

    Interface PaymentIntegration

    interface PaymentIntegration {
        application: ApplicationReference;
        automatedReversalConfiguration?: AutomatedReversalConfiguration;
        componentType: PaymentComponentType;
        connectorDeployment: ConnectorDeploymentReference;
        createdAt: string;
        createdBy?: CreatedBy;
        displayInfo?: DisplayInfo;
        id: string;
        key?: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name: string;
        predicate?: string;
        sortingInfo?: SortingInfo;
        status?: PaymentIntegrationStatus;
        type: string;
        version: number;
    }
    Index

    Properties

    application automatedReversalConfiguration? componentType connectorDeployment createdAt createdBy? displayInfo? id key? lastModifiedAt lastModifiedBy? name predicate? sortingInfo? status? type version

    Properties

    application: ApplicationReference

    Reference to an Application associated with the PaymentIntegration.

    automatedReversalConfiguration?: AutomatedReversalConfiguration

    Configuration of the Payment Integration automatic reversal.

    componentType: PaymentComponentType

    Indicates the component type of Payment Integration.

    connectorDeployment: ConnectorDeploymentReference

    Connector deployment info for the Payment Integration.

    createdAt: string

    Date and time (UTC) the PaymentIntegration was initially created.

    createdBy?: CreatedBy

    IDs and references that created the PaymentIntegration.

    displayInfo?: DisplayInfo

    Customization for the information that is displayed in the UI. Applies only when componentType is Component

    id: string

    Unique identifier of the PaymentIntegration.

    key?: string

    User-defined unique identifier of the PaymentIntegration. MinLength: 2 ​MaxLength: 256 ​Pattern: ^[A-Za-z0-9_-]+$

    lastModifiedAt: string

    Date and time (UTC) the PaymentIntegration was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the PaymentIntegration.

    name: string

    Name of the PaymentIntegration in the Merchant Center.

    predicate?: string

    Predicate in JSONata format. Applies only when componentType is Component.

    sortingInfo?: SortingInfo

    Sorting information of the Payment Integration.

    status?: PaymentIntegrationStatus

    Indicates whether the Payment Integration is active or not.

    type: string

    Type of the PaymentIntegration, for example, card, Paypal, or Applepay. This field must be same as used by the payment service provider (PSP) and must be supported by the Connector.

    Use `drop-in` for drop-in Payment Integrations.
    version: number

    Current version of the PaymentIntegration.

    Settings

    Member Visibility

    On This Page

    Properties