Documentation
Payment Link

The payment link defines an URL to automatically create transactions.

Payment links help to collect payments in cases where no backend is available for processing the payments on the merchant side. There is no need for any kind of server side programming by the merchant.

The payment is created by invoking a URL with specific parameters. The parameters are sent via a regular HTTP GET or POST request. For example, the billing address will be read from the parameters provided in the HTTP request to the payment link URL.

States
  • Create
    The create state indicates that the Payment Link is in creation.
  • Active
    The active state indicates that the Payment Link is active and may be used.
  • Inactive
    The inactive state indicates that the Payment Link is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Payment Link is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Allowed Payment Method Configurations
    The allowed payment method configurations restrict the payment methods which can be used with this payment link.
  • Applied Space View
    The payment link can be conducted in a specific space view. The space view may apply a specific design to the payment page.
  • Available From
    The available from date defines the earliest date on which the payment link can be used. When no date is specified there will be no restriction.
  • Available Until
    The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.
  • Billing Address Required
    By making the billing address required the transaction can only be created when a billing address is provided within the request.
  • Currency
    The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.
  • External ID
    The external id helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Language
    The language defines the language of the payment page. If no language is provided it can be provided through the request parameter.
  • Line Items
    The line items allows to define the line items for this payment link. When the line items are defined they cannot be overridden through the request parameters.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Maximal Number of Transactions
    The maximal number of transactions limits the number of transactions which can be created with this payment link.
  • Name
    The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Protection Mode
    The protection mode determines if the payment link is protected against tampering and in what way.
  • Shipping Address Required
    By making the shipping address required the transaction can only be created when a shipping address is provided within the request.
  • State
  • URL
    The URL defines the URL to which the user has to be forwarded to initialize the payment.
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.