Guides
Start typing to search…

Partners API

Connects business partners to Vourity's cloud platform

This API supports server-to-server integrations with our partner companies.

It has the following endpoints that can be used for different use cases:

  • Payment Request
  • Payment Cancel
  • Payment Capture
  • Payment Refund
  • POS Status
  • Action Request
  • Action Request Response
  • Set POS Status
  • Add Discount

One major use case is to integrate the Partners API with the POS 3 and use it as a separate payment terminal.

Here is a diagram that illustrates how it can be used:

1280

As you can see on the image above, the partner cloud or server sends a payment request to Vourity's cloud platform to initiate a payment process on the POS 3 terminal.

** Add more explanation

Payment Request

This endpoint makes a payment request.

curl --request POST \
  --url https://your.apiurl.com/pos-payment-request \
  --header 'Content-Type: application/json' \
  --header 'Host: api.vourity.com' \
  --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
  --header 'Ocp-Apim-Trace: true' \
  --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
  --data '{"sessionID":"a4101007-cd84-45c1-a493-fb37c342021c","msgType":"paymentRequest","merchantID":"0bc01e2d-cbe4-4593-be3a-e4e22effdb36","merchantName":"My Company Name","pointOfServiceID":"2114b1a2-ad68-469a-9fab-2bdd53eee06a","pointOfServiceName":"Test","totalAmountInclVat":2,"totalVatAmount":1,"currency":"SEK","responseWebhookUrl":"https://webhook.test.com","merchantReferences":{"orderId":"3ee34aa2-8436-4b6b-888a-d66de981434f","paymentId":"71821815-5aeb-4fe0-a60e-edec7a95bfde"},"_id":"a410a872-cd84-45c1-a493-fb37c342021c"}'
const fetch = require('node-fetch');

const url = 'https://your.apiurl.com/pos-payment-request';

const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: 'a4101007-cd84-45c1-a493-fb37c342021c',
    msgType: 'paymentRequest',
    merchantID: '0bc01e2d-cbe4-4593-be3a-e4e22effdb36',
    merchantName: 'My Company Name',
    pointOfServiceID: '2114b1a2-ad68-469a-9fab-2bdd53eee06a',
    pointOfServiceName: 'Test',
    totalAmountInclVat: 2,
    totalVatAmount: 1,
    currency: 'SEK',
    responseWebhookUrl: 'https://webhook.test.com',
    merchantReferences: {
      orderId: '3ee34aa2-8436-4b6b-888a-d66de981434f',
      paymentId: '71821815-5aeb-4fe0-a60e-edec7a95bfde'
    },
    _id: 'a410a872-cd84-45c1-a493-fb37c342021c'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/pos-payment-request")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"sessionID\":\"a4101007-cd84-45c1-a493-fb37c342021c\",\"msgType\":\"paymentRequest\",\"merchantID\":\"0bc01e2d-cbe4-4593-be3a-e4e22effdb36\",\"merchantName\":\"My Company Name\",\"pointOfServiceID\":\"2114b1a2-ad68-469a-9fab-2bdd53eee06a\",\"pointOfServiceName\":\"Test\",\"totalAmountInclVat\":2,\"totalVatAmount\":1,\"currency\":\"SEK\",\"responseWebhookUrl\":\"https://webhook.test.com\",\"merchantReferences\":{\"orderId\":\"3ee34aa2-8436-4b6b-888a-d66de981434f\",\"paymentId\":\"71821815-5aeb-4fe0-a60e-edec7a95bfde\"},\"_id\":\"a410a872-cd84-45c1-a493-fb37c342021c\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: 'a4101007-cd84-45c1-a493-fb37c342021c',
    msgType: 'paymentRequest',
    merchantID: '0bc01e2d-cbe4-4593-be3a-e4e22effdb36',
    merchantName: 'My Company Name',
    pointOfServiceID: '2114b1a2-ad68-469a-9fab-2bdd53eee06a',
    pointOfServiceName: 'Test',
    totalAmountInclVat: 2,
    totalVatAmount: 1,
    currency: 'SEK',
    responseWebhookUrl: 'https://webhook.test.com',
    merchantReferences: {
      orderId: '3ee34aa2-8436-4b6b-888a-d66de981434f',
      paymentId: '71821815-5aeb-4fe0-a60e-edec7a95bfde'
    },
    _id: 'a410a872-cd84-45c1-a493-fb37c342021c'
  })
};

fetch('https://your.apiurl.com/pos-payment-request', options)
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/pos-payment-request"

payload = {
    "sessionID": "a4101007-cd84-45c1-a493-fb37c342021c",
    "msgType": "paymentRequest",
    "merchantID": "0bc01e2d-cbe4-4593-be3a-e4e22effdb36",
    "merchantName": "My Company Name",
    "pointOfServiceID": "2114b1a2-ad68-469a-9fab-2bdd53eee06a",
    "pointOfServiceName": "Test",
    "totalAmountInclVat": 2,
    "totalVatAmount": 1,
    "currency": "SEK",
    "responseWebhookUrl": "https://webhook.test.com",
    "merchantReferences": {
        "orderId": "3ee34aa2-8436-4b6b-888a-d66de981434f",
        "paymentId": "71821815-5aeb-4fe0-a60e-edec7a95bfde"
    },
    "_id": "a410a872-cd84-45c1-a493-fb37c342021c"
}
headers = {
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Payment Cancel

This endpoint cancels a payment.

curl --request POST \
  --url https://your.apiurl.com/pos-payment-cancel \
  --header 'Content-Type: application/json' \
  --header 'Host: api.vourity.com' \
  --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
  --header 'Ocp-Apim-Trace: true' \
  --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
  --data '{"sessionID":"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6","pointOfServiceID":"34496536-c896-4cbc-9671-ee193878e80b","msgType":"paymentCancel"}'
const fetch = require('node-fetch');

const url = 'https://your.apiurl.com/pos-payment-cancel';

const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentCancel'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/pos-payment-cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"sessionID\":\"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6\",\"pointOfServiceID\":\"34496536-c896-4cbc-9671-ee193878e80b\",\"msgType\":\"paymentCancel\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentCancel'
  })
};

fetch('https://your.apiurl.com/pos-payment-cancel', options)
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/pos-payment-cancel"

payload = {
    "sessionID": "1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6",
    "pointOfServiceID": "34496536-c896-4cbc-9671-ee193878e80b",
    "msgType": "paymentCancel"
}
headers = {
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Payment Capture

This endpoint captures a payment.

curl --request POST \
  --url https://your.apiurl.com/pos-payment-capture \
  --header 'Content-Type: application/json' \
  --header 'Host: api.vourity.com' \
  --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
  --header 'Ocp-Apim-Trace: true' \
  --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
  --data '{"sessionID":"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6","pointOfServiceID":"34496536-c896-4cbc-9671-ee193878e80b","msgType":"paymentCapture"}'
const fetch = require('node-fetch');

const url = 'https://your.apiurl.com/pos-payment-capture';

const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentCapture'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/pos-payment-capture")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"sessionID\":\"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6\",\"pointOfServiceID\":\"34496536-c896-4cbc-9671-ee193878e80b\",\"msgType\":\"paymentCapture\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentCapture'
  })
};

fetch('https://your.apiurl.com/pos-payment-capture', options)
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/pos-payment-capture"

payload = {
    "sessionID": "1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6",
    "pointOfServiceID": "34496536-c896-4cbc-9671-ee193878e80b",
    "msgType": "paymentCapture"
}
headers = {
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Payment Refund

This endpoint refunds a payment.

curl --request POST \
  --url https://your.apiurl.com/pos-payment-refund \
  --header 'Content-Type: application/json' \
  --header 'Host: api.vourity.com' \
  --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
  --header 'Ocp-Apim-Trace: true' \
  --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
  --data '{"sessionID":"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6","pointOfServiceID":"34496536-c896-4cbc-9671-ee193878e80b","msgType":"paymentRefund","currency":"SEK","refundAmount":2,"refundReason":"Problem with the vending machine"}'
const fetch = require('node-fetch');

const url = 'https://your.apiurl.com/pos-payment-refund';

const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentRefund',
    currency: 'SEK',
    refundAmount: 2,
    refundReason: 'Problem with the vending machine'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/pos-payment-refund")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"sessionID\":\"1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6\",\"pointOfServiceID\":\"34496536-c896-4cbc-9671-ee193878e80b\",\"msgType\":\"paymentRefund\",\"currency\":\"SEK\",\"refundAmount\":2,\"refundReason\":\"Problem with the vending machine\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({
    sessionID: '1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6',
    pointOfServiceID: '34496536-c896-4cbc-9671-ee193878e80b',
    msgType: 'paymentRefund',
    currency: 'SEK',
    refundAmount: 2,
    refundReason: 'Problem with the vending machine'
  })
};

fetch('https://your.apiurl.com/pos-payment-refund', options)
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/pos-payment-refund"

payload = {
    "sessionID": "1bb58cfa-063d-4f5c-be5d-b90cfb64d1d6",
    "pointOfServiceID": "34496536-c896-4cbc-9671-ee193878e80b",
    "msgType": "paymentRefund",
    "currency": "SEK",
    "refundAmount": 2,
    "refundReason": "Problem with the vending machine"
}
headers = {
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

POS Status

This endpoint gets the POS status information.

curl --request GET \
     --url https://your.apiurl.com/pointOfServices/id/pos-status \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Host: api.vourity.com' \
     --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
     --header 'Ocp-Apim-Trace: true' \
     --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a'
const sdk = require('api')('@vourity/v1.0#19fj091kkty2l3ra');

sdk['pos-status']({
  id: 'id',
  Host: 'api.vourity.com',
  apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
  'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
  'Ocp-Apim-Trace': 'true'
})
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/pointOfServices/id/pos-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'

response = http.request(request)
puts response.read_body
const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  }
};

fetch('https://your.apiurl.com/pointOfServices/id/pos-status', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/pointOfServices/id/pos-status"

headers = {
    "Accept": "application/json",
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Action Request

This endpoint gets an action request.

curl --request GET \
     --url https://your.apiurl.com/action-request/id \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Host: api.vourity.com' \
     --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
     --header 'Ocp-Apim-Trace: true' \
     --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a'
const sdk = require('api')('@vourity/v1.0#4b80o1ukty4hdzz');

sdk['action-request']({
  id: 'id',
  Host: 'api.vourity.com',
  apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
  'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
  'Ocp-Apim-Trace': 'true'
})
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/action-request/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'

response = http.request(request)
puts response.read_body
const options = {
  method: 'GET',
  headers: {
    Accept: 'application/json',
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  }
};

fetch('https://your.apiurl.com/action-request/id', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/action-request/id"

headers = {
    "Accept": "application/json",
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

Action Request Response

This endpoint posts an action request response.

curl --request POST \
     --url https://your.apiurl.com/action-request-response \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Host: api.vourity.com' \
     --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
     --header 'Ocp-Apim-Trace: true' \
     --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
     --data '
{
     "responseCode": "accepted"
}
'
const sdk = require('api')('@vourity/v1.0#1cwyedikty750mi');

sdk['action-request-response']({responseCode: 'accepted'}, {
  Host: 'api.vourity.com',
  apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
  'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
  'Ocp-Apim-Trace': 'true'
})
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/action-request-response")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"responseCode\":\"accepted\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({responseCode: 'accepted'})
};

fetch('https://your.apiurl.com/action-request-response', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/action-request-response"

payload = {"responseCode": "accepted"}
headers = {
    "Accept": "application/json",
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Set POS Status

This endpoint sets the POS status.

curl --request PATCH \
     --url https://your.apiurl.com/set-pos-status \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Host: api.vourity.com' \
     --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
     --header 'Ocp-Apim-Trace: true' \
     --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a' \
     --data '
{
     "statusCode": "available"
}
'
const sdk = require('api')('@vourity/v1.0#7pys928kty7tj7j');

sdk['set-pos-status']({statusCode: 'available'}, {
  Host: 'api.vourity.com',
  apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
  'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
  'Ocp-Apim-Trace': 'true'
})
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/set-pos-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Accept"] = 'application/json'
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'
request.body = "{\"statusCode\":\"available\"}"

response = http.request(request)
puts response.read_body
const options = {
  method: 'PATCH',
  headers: {
    Accept: 'application/json',
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  },
  body: JSON.stringify({statusCode: 'available'})
};

fetch('https://your.apiurl.com/set-pos-status', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/set-pos-status"

payload = {"statusCode": "available"}
headers = {
    "Accept": "application/json",
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("PATCH", url, json=payload, headers=headers)

print(response.text)

Add Discount

This endpoint adds a discount.

curl --request POST \
     --url https://your.apiurl.com/add-discount \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'Host: api.vourity.com' \
     --header 'Ocp-Apim-Subscription-Key: 0b6c621c08e54f4b9900c89666e63618' \
     --header 'Ocp-Apim-Trace: true' \
     --header 'apikey: f2014e88-ec80-45ef-ad60-c29087efa97a'
const sdk = require('api')('@vourity/v1.0#19fj09okty89npf');

sdk['add-discount']({
  Host: 'api.vourity.com',
  apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
  'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
  'Ocp-Apim-Trace': 'true'
})
  .then(res => console.log(res))
  .catch(err => console.error(err));
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://your.apiurl.com/add-discount")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Host"] = 'api.vourity.com'
request["apikey"] = 'f2014e88-ec80-45ef-ad60-c29087efa97a'
request["Content-Type"] = 'application/json'
request["Ocp-Apim-Subscription-Key"] = '0b6c621c08e54f4b9900c89666e63618'
request["Ocp-Apim-Trace"] = 'true'

response = http.request(request)
puts response.read_body
const options = {
  method: 'POST',
  headers: {
    Accept: 'application/json',
    Host: 'api.vourity.com',
    apikey: 'f2014e88-ec80-45ef-ad60-c29087efa97a',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '0b6c621c08e54f4b9900c89666e63618',
    'Ocp-Apim-Trace': 'true'
  }
};

fetch('https://your.apiurl.com/add-discount', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
import requests

url = "https://your.apiurl.com/add-discount"

headers = {
    "Accept": "application/json",
    "Host": "api.vourity.com",
    "apikey": "f2014e88-ec80-45ef-ad60-c29087efa97a",
    "Content-Type": "application/json",
    "Ocp-Apim-Subscription-Key": "0b6c621c08e54f4b9900c89666e63618",
    "Ocp-Apim-Trace": "true"
}

response = requests.request("POST", url, headers=headers)

print(response.text)

Updated 6 months ago

What's Next...