Documentation
Documentation
Connector
Close API Documentation
Connector
States
  • Active
    The connector is active.
  • Deleted
    The connector is deleted and cannot be used anymore.
Properties
  • Authorization Timeout
    The duration within which the authorization process for a payment should complete.
  • Completion Configuration
    The completion configuration controlling how deferred completion is processed. If not present, deferred completion is not supported for this connector.
  • Connector Configuration
    The connector configuration created alongside the connector within its designated space. This configuration is used in transactions created using this connector.
  • Created On
    The date and time when the connector was created.
  • External ID
    A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
  • ID
    A unique identifier for the object.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Name
    The name used to identify the connector.
  • Payment Page Endpoint
    The URL where the user is redirected to process a payment. This endpoint is provided by the external service provider.
  • Processor
    The payment app processor that the connector belongs to. This relationship is defined when the connector is created.
  • Refund Configuration
    The refund configuration controlling the behavior for processing refunds. If not present, refunds are not supported for this connector.
  • State
    The object's current state.
  • Updated On
    The date and time when the connector was last updated.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.