Set Redirect URL

Set the default redirection URL for "Done"-status invoices. This setting will be applied for newly created invoices when the redirectURL parameter is absent or null in the invoice creation request.

PUT/api/company/settings/redirect-urlAuth: Required

Request Body

redirectURLstringRequired

URL-formatted link address. If null, redirection will use the redirectURL from the invoice creation request. If no link was provided during creation and Settings value is null, redirection won't be executed — the client will see the "Done" invoice page permanently.

Response

All the company payment settings will be returned with the redirectURL parameter's actual value.

PUT/api/company/settings/redirect-url

curl --location --request PUT 'https://my.paidlys.com/api/company/settings/redirect-url' \
  --header 'authorization: Bearer YOUR_PUBLIC_TOKEN' \
  --header 'content-type: application/json' \
  --data '<body>'

BODY

{
    "redirectURL": "https://myshop.com/payment-success"
}

Request Body​

Response​

Request Body

Response