Getting the paylink settings
To get the current paylink settings for a merchant:
Use the GET method with the /rest/v2/settings/terminal/paylink
endpoint.
Add the following header parameter in the request.
api-key
String
Required
The API key used to securely access the service.
The following response code appears when Paylink settings are retrieved successfully:
The following table describes the fields in the response body for the retrieved Paylink settings:
status
Text
A text in response to your API authentication request, such as:
Success: The API request was authenticated successfully.
Fail: The API request failed authentication.
exchange-id
String
The GUID (Global Unique Identifier) associated with the paylink settings.
links
Array
List of links associated with the merchant’s paylink settings.
rel
Text
The current status of the paylink setting. This field shows self
when the setting is enabled for a merchant.
href
Text
The URL associated with the merchant’s paylink settings.
payload
Object
Contains the details of the payload settings.
payload.paylink
Object
Contains the details of the paylink settings and configurations
payload.paylink.terminalId
Text
The internal terminal ID associated with the merchant’s paylink settings.
payload.paylink.enabled
Boolean
Indicates whether the paylink setting is enabled.
true
– The paylink setting is enabled.false
– The paylink setting is disabled.
payload.paylink.metadata
Object
Contains the details of the paylink configurations and attributes.
payload.paylink.metadata.show-billing-address
Boolean
Indicates whether the billing address section is shown on the payment form.
true
– The billing address section is shown.false
– The billing address section is hidden.
payload.paylink.metadata.required-biiling-address
Boolean
Indicates whether the billing address section is required on the payment form.
true
– The billing address section is required.false
– The billing address section is optional.
payload.success-url
String
The URL where customers are redirected after a successful payment.
payload.cancel-url
String
The URL where customers are redirected after canceling a payment.
payload.payloadType
String
The payload type classification.
The following table describes the HTTP status codes in the response body:
200
The paylink settings retrieved successfully.
401
Unauthorized
403
Forbidden
Last updated
Was this helpful?