Payment Services

POST /vouchers/generate/{voucherGroupId}

Requires authentication with server access token.

Create vouchers for a voucher group. The vouchers themselves are not returned, only an indication of success or failure. Failures indicate that the voucher group is not available or that you are requesting more vouchers than the limit on the group allows for. Information about failures can be found in the error property of the container.

If the voucher group is shared (i.e. its unique property is 0), this endpoint will respond with a 404, as individual vouchers cannot be generated from a shared voucher group.

Request

POST /api/2/vouchers/generate/{voucherGroupId}

voucherGroupId

required path parameter

ID of the voucher group to generate vouchers for

amount

optional

The number of unique vouchers to generate

Example request

cURL
Minimal example
curl https://login.schibsted.com/api/2/vouchers/generate/324673248 \
   -X POST \
   -d "oauth_token=[access token]"
With all parameters
curl https://login.schibsted.com/api/2/vouchers/generate/324673248 \
   -X POST \
   -d "oauth_token=[access token]" \
   -d "amount=99"
Java
Minimal example
SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    POST(token, "/vouchers/generate/324673248").
    getResponseBody();
With all parameters
Map<String, String> params = new HashMap<>() {{
    put("amount", "99");
}};

SpidOAuthToken token = spidClient.getServerToken();
String responseJSON = spidClient.
    POST(token, "/vouchers/generate/324673248", params).
    getResponseBody();

This example is an excerpt, see a full example

PHP
Minimal example
<?php
$client->auth();
echo var_dump($client->api("/vouchers/generate/324673248", "POST"));
With all parameters
<?php
$params = array(
    "amount" => "99"
);

$client->auth();
echo var_dump($client->api("/vouchers/generate/324673248", "POST", $params));

This example is an excerpt, see a full example

Clojure
Minimal 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 "/vouchers/generate/324673248"))
With all parameters
(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 "/vouchers/generate/324673248" {"amount" "99"}))

Response

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

Success: 200 OK

Returns a simple object indicating success of failure

Success indicator

success

boolean

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 Client does not have access to this voucher group
  • 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 Voucher group not found
  • 404 Not Found Failed to generate vouchers, see error object for further details
  • 420 Request Ratelimit exceeded

Sample response

JSON
{
  "success": true
}
JSON-P
callback({
  "success": true
});

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.