addPayment

PaymentData

true

object

Payment data.

PaymentInfo

true

object

Payment info.

Card

true

object

Card data.

Customer

true

object

Customer data.

Articles

true

array

Array of articles.

Cart

true

object

Cart data.

method

true

int

Payment method. Allowed values: 1= Invoice Factoring, 2=Invoice Handling, 4=Invoice Part Payment, 8=Card, 16=Bank, 32=Cash (Receipt) and 1024=Swish.

country

true

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

true

string

Language code for the language used on the invoice/recipt according to ISO 639-1, Currently supported: sv, da, no, en.

orderid

true

string

A unique order id generated by the shop as a reference.

currency

true

string

Currency code to be used for the payment according to ISO 4217. Currently supported: SEK, DKK, NOK, GBP, EUR, USD. Note: Method=16 (Bank) currently only accepts SEK and Method=4 (Part Payment) currently only accepts SEK.

autoactivate

false

string

Flag showing if the payment should be auto activated, thus if set, payment is finalized and no activatePayment command is required. For factoring invoice, handling invoice and partpayment, autoactivate=1 locks invoice, sends it to Qvickly. For factoring invoice and handling invoice an invoice will be sent to the given customer email. For card/bank payment, autoactivate=1 captures amount immediately. Default=0. You can also enter a date for when the payment should be activated e.g. 2015-02-28.

autocancel

false

int

Number of minutes until the payment should be auto cancelled, thus if set, payment is cancelled and no cancelPayment command is required.

logo

false

string

Change logo for the payment. You will find the reference to your logo in your Qvickly Portal account. You will find it in My account -> Account Information -> Settings. The reference to be used is the file name e.g. Logo1.jpg. If left empty the standard logo will be used.

paymentplanid

false

int

Paymentplan id of the selected part payment plan. Required if paymentmethod is PartPayment. If you wish to use a different currency for part payment than SEK, please contact us by clicking on this link.

accepturl

false

string

Url to which the customer is redirected after a completed payment. See accepturl

cancelurl

false

string

Url to which the customer is redirected after a failed or cancelled payment. See cancelurl

callbackurl

false

string

Url to which callback data is sent after the customer has succesfully completed a card or bank payment. Callback is initiated at the same time as accepturl, thus it can’t be assumed that callback data will arrive before accepturl data. No response is required to a callback request, the data just has to be received. If callback data is not received, Qvickly server will try to send callback data again once a minute first 10 minutes, once an hour first 10 hours, once a day first 7 days, then finally once a month for next 3 months. See callbackurl

bankid

false

string

Support BankID. If set to true, the plugin supports the use of BankID for identification. Default is false. If the account has force

feeid

false

string

Fee id of the fee to add.

paymentdate

false

date

Payment date in invoice/receipt on format YYYY-MM-DD. Default is current date.

paymentterms

false

int

Payment terms field in invoice/receipt. Given in number of days.

yourreference

false

string

Your reference field in invoice/receipt.

ourreference

false

string

Our reference field in invoice/receipt.

projectname

false

string

Project name field in invoice/receipt.

delivery

false

string

Delivery method. Post, etc.

deliveryterms

false

string

Delivery terms field in invoice/receipt. FOB, etc.

autocredit

false

boolean

If this is set to true, then if the invoice is not paid before the duedate, the invoice will be automatically credited. Default is false.

promptname

false

int

Flag indicating if name should be prompted in payment window. Only valid for card payments (method=8). Default=0 (no prompt).

recurring

false

int

Flag indicating if card payment is or should be saved to make it possible to do recurring payments, like monthly subscriptions. If set, then after first payment has been made, an addPayment call will make another card payment automatically. Requires a special acquirer agreement (inlösenavtal). Only valid for card payments (method=8). Default=0 (no recurring payment). Notice that this is only needed for the initial recurring payment.

recurringnr

false

int

Payment number (datanumber) received from first purchase for making a recurring payment.

accepturl

false

string

Url to which the customer is redirected after a completed payment. See accepturl

cancelurl

false

string

Url to which the customer is redirected after a failed or cancelled payment. See accepturl

returnmethod

false

string

Http return method to accepturl, cancelurl and callbackurl. Default is ‘POST’, but can be set to ‘GET’ instead.

callbackurl

false

string

Url to which callback data is sent after the customer has succesfully completed a card or bank payment. Callback is initiated at the same time as accepturl, thus it can’t be assumed that callback data will arrive before accepturl data. No response is required to a callback request, the data just has to be received. If callback data is not received, Qvickly server will try to send callback data again once a minute first 10 minutes, once an hour first 10 hours, once a day first 7 days, then finally once a month for next 3 months. See callbackurl

nr

false

int

Customer number. If not given, next available customer number in Qvickly will be assigned.

pno

false

string

national identification number number or swedish organization number. Sent as YYMMDD-XXXX, it can be sent with or without “-” and with or without the two first numbers (19 or 20) in the year. Mandatory field for Factoring and PartPayment methods, but not for receipt, card and bank payments.

Billing

false

object

Billing address.

Shipping

false

object

Shipping address.

taxrate

true

dec

Article tax rate in percent.

withouttax

true

dec

Total article row excluding tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR). Amount given will overwrite any errors in rounding of articles row sum. Mandatory since at least one article is required to add up to total.withouttax. Note When a discount is applicable on the article, you have to deduct the discount amount from the withouttax amount.

artnr

false

string

Article number.

title

true

string

Article description.

quantity

false

dec

Article quantity.

aprice

false

dec

Article unit price without tax in 1/100 of currency (i.e. öre if currency is SEK, cent if currency is EUR).

discount

false

dec

Article discount in %.

unit

false

enum

Article unit. Defaults to 'st' if none given.

Total

true

object

Total summary of payment

Handling

false

object

Cost for handling

Shipping

false

object

Cost for shipping

function

true

string

The function name to be used, for this page it’s addPayment