Payment Services

POST /paylink/{paylinkId}/unlock

Requires authentication with server access token.

Unlock paylink by ID.

Request

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

paylinkId

required path parameter

ID of the paylink

paylinkId

required

ID of the paylink

Example request

cURL
curl https://login.schibsted.com/api/2/paylink/777/unlock \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "paylinkId=777"
Java
Map<String, String> params = new HashMap<>() {{
    put("paylinkId", "777");
}};

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

This example is an excerpt, see a full example

PHP
<?php
$params = array(
    "paylinkId" => "777"
);

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

This example is an excerpt, see a full example

Clojure
(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/unlock" {"paylinkId" "777"}))

Response

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

Success: 200 OK

Paylink is unlocked

API Exception

code

integer

The API error code

type

string

A textual representation of the kind of error that occurred

description

string

Further details about the error

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.

  • 400 Bad Request Bad request. 'paylinkId' is not a valid integer
  • 400 Bad Request Paylink isn't locked
  • 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.
  • 404 Not Found Paylink not found
  • 404 Not Found Paylink is expired
  • 404 Not Found Paylink is used or deleted
  • 420 Request Ratelimit exceeded

Comments/feedback

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.