You are here:

Create an 'empty' shortened URL

A shortened URL is generated automatically after a payment is created. But when you want to use a QR code image inside a PDF that points to a payment and you also want to send this PDF as attachment for a payment, you need a shortened URL upfront, before the payment is created.

To accomplish this, you can call the URL shortener without a URL in the query string:
https://spbl.eu/create/<entitykey>

Example 'empty shortened URL creation

For instance; if you want to create a shortened URL for the entity with key ‘e7140a88-cbba-4cc2-be9f- 6e90536703ef’, you execute an HTTP-GET command with the correct authentication header: spbl.eu/create/e7140a88-cbba-4cc2-be9f-6e90536703ef

In this example the service returns the URL: spbl.eu/b78aav0kDt but this URL doesn’t do anything (yet).

You can use this URL (or generate a QR image) to put in a pdf that can then be used as an attachment for a payment mail. When you then create a new payment or mandate via the API, you can supply this (earlier created) URL as a value in the mapping for the parameter [*ShortenedUrl]. When the payment or mandate is created successfully and the supplied shortened url hasn’t been used before, the created payment/mandate can be reached using the supplied URL. No new URL is generated in that case.

Date updated: 2019-07-31
Trust Guard