-
Allowed Payment Method Configurations
The payment method configurations that customers can use for making payments.
-
Allowed Redirection Domains
The domains to which the user is allowed to be redirected after the payment is completed.
The following options can be configured:
Exact domain: enter a full domain, e.g. (https://example.com).
Wildcard domain: use to allow subdomains, e.g. (https://*.example.com).
All domains: use (ALL) to allow redirection to any domain (not recommended for security reasons).
No domains : use (NONE) to disallow any redirection.
Only one option per line is allowed. Invalid entries will be rejected.
-
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.