Documentation
Documentation
Payment Link
Close API Documentation
Payment Link

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 payment method configurations that customers can use for making payments.
  • Applied Space View
    The payment link can be used within a specific space view, which may apply a customized design to the payment page.
  • Available From
    The earliest date the payment link can be used to initiate a transaction. If no date is provided, the link will be available immediately.
  • Available Until
    The latest date the payment link can be used to initiate a transaction. If no date is provided, the link will remain available indefinitely.
  • Billing Address Handling Mode
    The handling mode defines whether a billing address is required and specifies how it should be provided.
  • Currency
    The three-letter currency code (ISO 4217). If not specified, it must be provided in the 'currency' request parameter.
  • 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.
  • Language
    The language for displaying the payment page. If not specified, it can be supplied via the 'language' request parameter.
  • Line Items
    The line items representing what is being sold. If not specified, they can be supplied via request parameters.
  • Linked Space ID
    The ID of the space this object belongs to.
  • Maximal Number of Transactions
    The maximum number of transactions that can be initiated using the payment link.
  • Name
    The name used to identify the payment link.
  • 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 defines whether the payment link is protected against tampering and specifies the protection method.
  • Shipping Address Handling Mode
    The handling mode defines whether a shipping address is required and specifies how it should be provided.
  • State
    The object's current state.
  • URL
    The public URL to share with customers for making payments.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.