Version: 3.0.0

Pay-by-Link API

Using our Pay-by-Link API, you can manage Pay-by-Link transactions.

To create Pay-by-Links, use the Transaction API.

Authentication

HTTP: Basic Auth

To authenticate API requests, the API username and password must be sent as BASIC Authentication in the Authorization header, as defined in RFC 7617. To achieve this, the username and password are first concatenated with a : (colon) separator, and the resulting string is then Base64 encoded. Here is an example of how this process works:

1. Suppose the API username is anyApiUser and the password is myPassword.
2. Concatenate the username and password with a : separator: anyApiUser:myPassword.
3. Base64 encode the concatenated string: YW55QXBpVXNlcjpteVBhc3N3b3JkCg==.
4. Finally, include the Authorization header in the API request with the Base64 encoded string, like so: Authorization: Basic YW55QXBpVXNlcjpteVBhc3N3b3JkCg==.

tip

Many programming frameworks will automatically handle the BASIC Authentication process for you once you provide the username and password to the appropriate request object.

Security Scheme Type:	http
HTTP Authorization Scheme:	basic