check |
paymentOrder |
object |
The relative URL and unique identifier of the paymentorder resource this payer belongs to. Please read about URL Usage to understand how this and other URLs should be used in your solution. |
check |
requestTraExemption |
bool |
Set to true if the merchant requests a TRA exemption. |
check |
operation |
string |
Determines the initial operation, defining the type of payment order created. |
check |
currency |
string |
The currency of the payment. |
check |
amount |
integer |
The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK. |
check |
vatAmount |
integer |
The payment’s VAT (Value Added Tax) amount , entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK. The vatAmount entered will not affect the amount shown on the payment page, which only shows the total amount . This field is used to specify how much of the total amount the VAT will be. Set to 0 (zero) if there is no VAT amount charged. |
check |
description |
string |
The description of the payment order. |
check |
userAgent |
string |
The user agent of the payer. Should typically be set to the value of the User-Agent header sent by the payer’s web browser. |
check |
language |
string |
The language of the payer. |
check |
productName |
string |
Used to tag the payment as Digital Payments v3.0, either in this field or the header, as you won’t get the operations in the response without submitting this field. |
|
implementation |
string |
Indicates which implementation to use. |
check |
urls |
object |
The urls object, containing the URLs relevant for the payment order. |
check |
hostUrls |
array |
The array of URLs valid for embedding of Swedbank Pay Seamless Views. |
check |
completeUrl |
string |
The URL that Swedbank Pay will redirect back to when the payer has completed their interactions with the payment. This does not indicate a successful payment, only that it has reached a final (complete) state. A GET request needs to be performed on the payment order to inspect it further. See completeUrl for details. |
|
cancelUrl |
string |
The URL to redirect the payer to if the payment is cancelled, either by the payer or by the merchant trough an abort request of the payment or paymentorder . |
check |
callbackUrl |
string |
The URL that Swedbank Pay will perform an HTTP POST against every time a transaction is created on the payment order. See callback for details. |
check |
termsOfServiceUrl |
string |
The URL to the terms of service document which the payer must accept in order to complete the payment. HTTPS is a requirement. |
check |
payeeInfo |
object |
The payeeInfo object, containing information about the payee (the recipient of the money). See payeeInfo for details. |
check |
payeeId |
string |
The ID of the payee, usually the merchant ID. |
check |
payeeReference |
string |
A unique reference from the merchant system. Set per operation to ensure an exactly-once delivery of a transactional operation. Length and content validation depends on whether the transaction.number or the payeeReference is sent to the acquirer. If Swedbank Pay handles the settlement, the transaction.number is sent and the payeeReference must be in the format of A-Za-z0-9 and string(30) . If you handle the settlement, Swedbank Pay will send the payeeReference and it will be limited to the format of string(12) . All characters must be digits. In Invoice Payments payeeReference is used as an invoice/receipt number, if the receiptReference is not defined. |
|
payeeName |
string |
The name of the payee, usually the name of the merchant. |
|
productCategory |
string(50) |
A product category or number sent in from the payee/merchant. This is not validated by Swedbank Pay, but will be passed through the payment process and may be used in the settlement process. |
|
orderReference |
string(50) |
The order reference should reflect the order reference found in the merchant’s systems. |
|
subsite |
string(40) |
The subsite field can be used to perform a split settlement on the payment. The different subsite values must be resolved with Swedbank Pay reconciliation before being used. If you send in an unknown subsite value, it will be ignored and the payment will be settled using the merchant’s default settlement account. Must be in the format of A-Za-z0-9 . |
|
payer |
object |
The payer object. |
|
nationalIdentifier |
object |
The national identifier object. |
|
socialSecurityNumber |
string |
The payer’s social security number. |
|
countryCode |
string |
The country code of the payer. |
|
requireConsumerInfo |
bool |
Set to true if the merchant wants to receive profile information from Swedbank Pay. Applicable for when the merchant only needs email and/or msisdn for digital goods, or when the full shipping address is necessary. If set to false , Swedbank Pay will depend on the merchant to send email and/or msisdn for digital products and shipping address for physical orders. |
|
digitalProducts |
bool |
Set to true for merchants who only sell digital goods and only require email and/or msisdn as shipping details. Set to false if the merchant also sells physical goods. |
|
email |
string |
Payer’s registered email address. |
|
msisdn |
string |
Payer’s registered mobile phone number. |
|
authentication |
object |
The authentication object related to the payer . |
|
type |
string |
Set to Physical or Digital , depending on how the authentication was done. |
|
method |
string |
Indicator of the authentication method. Set to OneFactor , MultiFactor , BankId , nationalIdentityCard or RecurringToken . |
|
nationalIdentityCardType |
string |
Form of identity card used for the authentication. Set to Passport , DriversLicense or BankCard . |
|
reference |
string |
Used if the authentication method has an associated reference. Use the passport number for Passport authentications, session numbers for BankID sessions etc. |
|
shippingAddress |
object |
The shipping address object related to the payer . |
|
firstName |
string |
The first name of the addressee – the receiver of the shipped goods. |
|
lastName |
string |
The last name of the addressee – the receiver of the shipped goods. |
|
email |
string |
Payer’s registered email address. |
|
msisdn |
string |
Payer’s registered mobile phone number. |
|
streetAddress |
string |
Payer’s street address. Maximum 50 characters long. |
|
coAddress |
string |
Payer’s c/o address, if applicable. |
|
city |
string |
Payer’s city of residence. |
|
zipCode |
string |
Payer’s zip code. |
|
countryCode |
string |
Country code for the payer’s country of residence. |
|
billingAddress |
object |
The billing address object related to the payer . |
|
firstName |
string |
The first name of the addressee – the receiver of the shipped goods. |
|
lastName |
string |
The last name of the addressee – the receiver of the shipped goods. |
|
email |
string |
Payer’s registered email address. |
|
msisdn |
string |
Payer’s registered mobile phone number. |
|
streetAddress |
string |
Payer’s street address. Maximum 50 characters long. |
|
coAddress |
string |
Payer’s c/o address, if applicable. |
|
city |
string |
Payer’s city of residence. |
|
zipCode |
string |
Payer’s zip code. |
|
countryCode |
string |
Country code for the payer’s country of residence. |
|
accountInfo |
object |
Object related to the payer containing info about the payer’s account. |
|
accountAgeIndicator |
string |
Indicates the age of the payer’s account.
01 (No account, guest checkout)
02 (Created during this transaction)
03 (Less than 30 days old)
04 (30 to 60 days old)
05 (More than 60 days old) |
|
accountChangeIndicator |
string |
Indicates when the last account changes occurred.
01 (Changed during this transaction)
02 (Less than 30 days ago)
03 (30 to 60 days ago)
04 (More than 60 days ago) |
|
accountChangePwdIndicator |
string |
Indicates when the account’s password was last changed.
01 (No changes)
02 (Changed during this transaction)
03 (Less than 30 days ago)
04 (30 to 60 days ago)
05 (More than 60 days old) |
|
shippingAddressUsageIndicator |
string |
Indicates when the payer’s shipping address was last used.
01 (This transaction)
02 (Less than 30 days ago)
03 (30 to 60 days ago)
04 (More than 60 days ago) |
|
shippingNameIndicator |
string |
Indicates if the account name matches the shipping name.
01 (Account name identical to shipping name)
02 (Account name different from shipping name) |
|
suspiciousAccountActivity |
string |
Indicates if there have been any suspicious activities linked to this account.
01 (No suspicious activity has been observed)
02 (Suspicious activity has been observed) |
|
addressMatchIndicator |
bool |
Allows the antifraud system to indicate if the payer’s billing and shipping address are the same. |
|
orderItems |
object |
The object containing items being purchased with the order, and info about them. If you have GPC codes for the items and add them here, you won’t have to include the items at the bottom of the code example. |
check |
reference |
string |
A reference that identifies the order item. |
check |
name |
string |
The name of the order item. |
check |
type |
enum |
PRODUCT , SERVICE , SHIPPING_FEE , DISCOUNT , VALUE_CODE , or OTHER . The type of the order item. |
check |
class |
string |
The classification of the order item. Can be used for assigning the order item to a specific product category, such as MobilePhone . Note that class cannot contain spaces and must follow the regex pattern [\w-]* . Swedbank Pay may use this field for statistics. |
|
itemUrl |
string |
The URL to a page that can display the purchased item, such as a product page |
|
imageUrl |
string |
The URL to an image of the order item. |
|
description |
string |
The human readable description of the order item. |
|
discountDescription |
string |
The human readable description of the possible discount. |
check |
quantity |
number |
The 4 decimal precision quantity of order items being purchased. |
check |
quantityUnit |
string |
The unit of the quantity, such as pcs , grams , or similar. |
check |
unitPrice |
integer |
The price per unit of order item, including VAT. |
|
discountPrice |
integer |
If the order item is purchased at a discounted price. This field should contain that price, including VAT. |
check |
vatPercent |
integer |
The percent value of the VAT multiplied by 100, so 25% becomes 2500 . |
check |
amount |
integer |
The transaction amount (including VAT, if any) entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK. |
check |
vatAmount |
integer |
The payment’s VAT (Value Added Tax) amount , entered in the lowest monetary unit of the selected currency. E.g.: 10000 = 100.00 SEK, 5000 = 50.00 SEK. The vatAmount entered will not affect the amount shown on the payment page, which only shows the total amount . This field is used to specify how much of the total amount the VAT will be. Set to 0 (zero) if there is no VAT amount charged. |
|
riskIndicator |
object |
This object consists of information that helps verifying the payer. Providing these fields decreases the likelihood of having to prompt for 3-D Secure authentication of the payer when they are authenticating the purchase. |
|
deliveryEmailAdress |
string |
For electronic delivery (see shipIndicator below), the email address to which the merchandise was delivered. Providing this field when appropriate decreases the likelihood of a 3-D Secure authentication for the payer. |
|
deliveryTimeFrameIndicator |
string |
Indicates the merchandise delivery timeframe.
01 (Electronic Delivery)
02 (Same day shipping)
03 (Overnight shipping)
04 (Two-day or more shipping). |
|
preOrderDate |
string |
For a pre-ordered purchase. The expected date that the merchandise will be available. Format: YYYYMMDD . |
|
preOrderPurchaseIndicator |
string |
Indicates whether the payer is placing an order for merchandise with a future availability or release date.
01 (Merchandise available)
02 (Future availability). |
|
shipIndicator |
string |
Indicates shipping method chosen for the transaction.
01 (Ship to cardholder’s billing address)
02 (Ship to another verified address on file with merchant)
03 (Ship to address that is different than cardholder’s billing address)
04 (Ship to Store / Pick-up at local store. Store address shall be populated in the riskIndicator.pickUpAddress and payer.shippingAddress fields)
05 (Digital goods, includes online services, electronic giftcards and redemption codes)
06 (Travel and Event tickets, not shipped)
07 (Other, e.g. gaming, digital service) |
|
giftCardPurchase |
bool |
true if this is a purchase of a gift card. |
|
reOrderPurchaseIndicator |
string |
Indicates whether the cardholder is reordering previously purchased merchandise.
01 (First time ordered)
02 (Reordered). |
|
pickUpAddress |
object |
Object related to the riskIndicator , containing info about the merchant’s pick-up address. If the shipIndicator is set to 04 , this should be filled out with the merchant’s pick-up address. Do not use if the shipment is sent or delivered to a consumer address (ShipIndicator 01 , 02 or 03 ). In those cases, the shipping address in the Payer field should be used instead. |
|
pickUpAddress.Name |
string |
The name of the shop or merchant. |
|
pickUpAddress.streetAddress |
string |
The shop or merchant’s street address. Maximum 50 characters long. |
|
pickUpAddress.coAddress |
string |
The shop or merchant’s c/o address, if applicable. |
|
pickUpAddress.City |
string |
The city where the shop or merchant is located. |
|
pickUpAddress.zipCode |
string |
The zip code where the shop or merchant is located. |
|
pickUpAddress.countryCode |
string |
The country code where the shop or merchant is located. |
|
items |
object |
Object related to the riskIndicator , containing info about the items ordered. Should be added if the GPC codes for the items are available. If the orderItems object is used and includes the GPC codes, there is no need to add this field. Should only be used by merchants who don’t use the orderItems object. |
|
gpcNumber |
string |
The specific GPC Number for the order line. |
|
amount |
string |
The amount of the specific order line. |