Payment Services

POST /paylink/{paylinkId}/use

Requires authentication with server access token.

Mark paylink as used by ID.


POST /api/2/paylink/{paylinkId}/use


required path parameter

ID of the paylink



ID of the paylink

Example request

curl \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "paylinkId=777"
Map<String, String> params = new HashMap<>() {{
    put("paylinkId", "777");

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    POST(token, "/paylink/777/use", params).

This example is an excerpt, see a full example

$params = array(
    "paylinkId" => "777"

echo var_dump($client->api("/paylink/777/use", "POST", $params));

This example is an excerpt, see a full example

(ns example
  (:require [spid-client-clojure.core :as spid]))

(let [client (spid/create-client "[client-id]" "[secret]")
      token (spid/create-server-token client)]
  (spid/POST client token "/paylink/777/use" {"paylinkId" "777"}))


This endpoint supports the JSON and JSON-P response formats.


Failure cases

Some HTTP response codes are used for multiple error situations. There is no consistent way to tell these apart, but the error object will contain a textual explanation of the reason for the error. For explanation on OAuth related failures and errors see OAuth authentication failures.

  • 401 Unauthorized You don't have administration rights for this client.
  • 401 Unauthorized Your client doesn't have administration rights for this client.
  • 403 Forbidden Client is not authorized to access this API endpoint. Contact SPiD to request access.
  • 403 Forbidden Requesting IP is not whitelisted
  • 403 Forbidden Access token rejected
  • 404 Not Found Unknown client ID
  • 404 Not Found Client ID mismatch. The client making the request is no the owner of this resource, and does not have administrative privileges for it.
  • 420 Request Ratelimit exceeded


Do you have questions, or just want to contribute some newly gained insight? Want to share an example? Please leave a comment. SPiD reads and responds to every question. Additionally, your experience can help others using SPiD, and it can help us continuously improve our documentation.