Documentation
Documentation
Payment Link
Close API 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 Handling Mode
    The billing address handling mode controls if the address is collected or not and how it is collected.
  • 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
    A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
  • ID
    A unique identifier for the object.
  • 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. If no amount for the payment link is defined, the additional checkout page to enter the amount is shown to the consumer.
  • Linked Space ID
    The ID of the space this object 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 date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Protection Mode
    The protection mode determines if the payment link is protected against tampering and in what way.
  • Shipping Address Handling Mode
    The shipping address handling mode controls if the address is collected or not and how it is collected.
  • State
    The object's current state.
  • URL
    The URL defines the URL to which the user has to be forwarded to initialize the payment.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.