getPaymentinfo

getPaymentinfo is used for getting info about a payment.

An example can be found here Get payment info example

Request

Data

Property	Required	Type	Description
number	true	int	The payment number of the payment/invoice you wish to get info about.

Function

Property	Required	Type	Description
function	true	string	The function name to be used, for this page it’s getPaymentinfo

{
    "credentials": {
        "id": "12345",
        "hash": "0e3e4aa976cdd55179837b5b15da90cd8165f63b84ebd59cf1522b81f45e2343022dd32614ecf639aa260477649a7e93a5c05937dca989c2d72d322ec57c6092",
        "version": "2.5.0",
        "client": "Pluginname:Qvickly:1.0",
        "language": "sv",
        "serverdata": {"HTTP_HOST":"developer.qvickly.io","HTTP_CONNECTION":"keep-alive","HTTP_CACHE_CONTROL":"max-age=0","HTTP_ACCEPT":"text\/html,application\/xhtml+xml,application\/xml;q=0.9,image\/webp,*\/*;q=0.8","HTTP_USER_AGENT":"Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_10_1) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/39.0.2171.95 Safari\/537.36","HTTP_ACCEPT_ENCODING":"gzip, deflate, sdch","HTTP_ACCEPT_LANGUAGE":"en-US,en;q=0.8","PATH":"\/sbin:\/usr\/sbin:\/bin:\/usr\/bin","SERVER_SOFTWARE":"Apache\/2.2.26 (Amazon)","SERVER_NAME":"developer.qvickly.io","SERVER_ADDR":"172.31.22.88","SERVER_PORT":"80","REMOTE_ADDR":"2.71.114.219","REMOTE_PORT":"53241","GATEWAY_INTERFACE":"CGI\/1.1","SERVER_PROTOCOL":"HTTP\/1.1","REQUEST_METHOD":"GET","QUERY_STRING":"","REQUEST_TIME":1421313644},
        "time": "1417004339.9291",
        "test": "true"
    },
    "data": {
        "number": "1000235"
    },
    "function": "getPaymentinfo"
}

Response

PaymentData

Property	Type	Description
method	int	Payment method. Allowed values: Methods
paymentplanid	int	Paymentplan id of the selected part payment plan. Required if paymentmethod is PartPayment.
currency	string	Currency code to be used for the payment according to ISO 4217. Currently supported: SEK, DKK, NOK, GBP, EUR, USD.
country	string	Country code for the country where purchase is made (normally store location) according to ISO 3166-1 alpha-2, e.g. SE, DK, NO, GB.
language	string	Language code for the language used on the invoice/recipt according to ISO 639-1, Currently supported: sv, da, no, en.
autoactivate	int	Flag showing if the payment was auto activated.
orderid	string	A unique order id generated by the shop as a reference.
status	string	The status of the payment.
paymentid_related	int	If there is an related payment to the requested payment e.g. original invoice for credit invoice.
accepturl	string	Url to which the customer was redirected after a completed payment.
cancelurl	string	Url to which the customer was redirected after a failed or cancelled payment.
callbackurl	string	Url to which callback data was sent after the customer has completed a payment. Data returned is defined below and same as for accepturl.
url	string	The url link to the requested invoice.

PaymentInfo

Property	Type	Description
paymentdate	date	Payment date in invoice/receipt on format YYYY-MM-DD.
paymentterms	int	Payment terms field in invoice/receipt. Given in number of days.
yourreference	string	Your reference field in invoice/receipt.
ourreference	string	Our reference field in invoice/receipt.
projectname	string	Project name field in invoice/receipt.
deliverymethod	string	Delivery method. Post, etc.
deliveryterms	string	Delivery terms field in invoice/receipt. FOB, etc.

Card

Property	Type	Description
promptname	int	Flag indicating if name was prompted in payment window.
recurring	int	Flag indicating if card payment is possible to do recurring payments, like monthly subscriptions.
recurringnr	int	Payment number received from first purchase for making a recurring payment.
accepturl	string	Url to which the customer was redirected after a completed payment.
cancelurl	string	Url to which the customer was redirected after a failed or cancelled payment.
callbackurl	string	Url to which callback data was sent after the customer has completed a payment. Data returned is defined below and same as for accepturl.
returnmethod	string	Http return method to accepturl and cancelurl. ‘POST’ or ‘GET’.

Settlement

Property	Type	Description
number	int	Settlement number.
date	date	Date for when the settlement was done. Sent as YYYY-MM-DD.

Customer

Property	Type	Description
nr	int	Customer number.
pno	string	Swedish national identification number or swedish organization number. Sent as YYMMDD-XXXX.
Billing	object	Billing address.
Shipping	object	Shipping address.

Customer billing address

Property	Type	Description
firstname	string	Firstname.
lastname	string	Lastname.
company	string	Company name.
street	string	Billing street.
street2	string	Second row of Street.
zip	string	Zipcode.
city	string	City.
country	string	Country.
phone	string	Phone number.
email	string	Billing email.

Customer shipping address

Property	Type	Description
firstname	string	Firstname.
lastname	string	Lastname.
company	string	Company name.
street	string	Shipping street.
street2	string	Second row of Street.
zip	string	Zipcode.
city	string	City.
country	string	Country.
phone	string	Phone number.

Articles

Articles is an array of objects containing information about the articles in the payment.

Property	Type	Description
artnr	string	First article number.
title	string	First article description.
quantity	dec	First article quantity.
aprice	dec	First article unit price without tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
discount	dec	First article discount in %.
withouttax	dec	Total article row excluding tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
taxrate	dec	First article tax rate in percent.

Cart

Handling

Property	Type	Description
withouttax	dec	Handling charge in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
taxrate	dec	Handling vat rate in %.

Shipping

Property	Type	Description
withouttax	dec	Shipping charge in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
taxrate	dec	Shipping vat rate in %.

Total

Property	Type	Description
rounding	dec	Rounding in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
withouttax	int	Total payment excluding tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
tax	int	Total tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).
withtax	int	Total payment including tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).

{
   "credentials":{
      "hash":"5d93099de768c826aefb6f4ebcfd2dbce32b36e49a69e1cac8244abb6969d75e833006c9cc2e315b72807a179efd518e4933188d99e74903d391954697d97737"
   },
   "data":{
      "PaymentData":{
         "method":"1",
         "paymentplanid":"",
         "currency":"SEK",
         "country":"SE",
         "language":"sv",
         "autoactivate":"0",
         "orderid":"P123456718",
         "status":"Created",
         "paymentid_related":"",
         "url":""
      },
      "PaymentInfo":{
         "paymentdate":"2014-07-31",
         "paymentterms":"14",
         "yourreference":"Purchaser X",
         "ourreference":"Seller Y",
         "projectname":"Project Z",
         "deliverymethod":"Post",
         "deliveryterms":"FOB"
      },
      "Card":{
         "promptname":"",
         "recurring":"",
         "recurringnr":"",
         "accepturl":"https://www.mystore.se/completedpayment",
         "cancelurl":"https://www.mystore.se/failedpayment",
         "callbackurl":"https://www.mystore.se/callback.php",
         "returnmethod":""
      },
      "Settlement": {
         "number": "2",
         "date": "2018-12-17"
      },
      "Customer":{
         "nr":"12",
         "pno":"8706240739",
         "Billing":{
            "firstname":"Firstname",
            "lastname":"Lastname",
            "company":"Company",
            "street":"Street",
            "street2":"Street2",
            "zip":"12345",
            "city":"Lund",
            "country":"SE",
            "phone":"0712-345678",
            "email":"test@developer.qvickly.io"
         },
         "Shipping":{
            "firstname":"Firstname",
            "lastname":"Lastname",
            "company":"Company",
            "street":"Shipping Street 1",
            "street2":"Shipping Street2",
            "zip":"23456",
            "city":"Lund",
            "country":"SE",
            "phone":"0711-345678"
         }
      },
      "Articles":[
         {
            "artnr":"",
            "title":"Article 1",
            "quantity":"2",
            "aprice":"1234",
            "tax":"617",
            "discount":"0",
            "withouttax":"2468",
            "taxrate":"25"
         },
         {
            "artnr":"B456",
            "title":"Article 2",
            "quantity":"3.5",
            "aprice":"56780",
            "tax":"44714",
            "discount":"10",
            "withouttax":"178857",
            "taxrate":"25"
         }
      ],
      "Cart":{
         "Handling":{
            "withouttax":"1000",
            "taxrate":"25"
         },
         "Shipping":{
            "withouttax":"3000",
            "taxrate":"25"
         },
         "Total":{
            "rounding":"44",
            "withouttax":"185325",
            "tax":"46331",
            "withtax":"231700"
         }
      }
   }
}

Last modified: 13 September 2024