Checkout v2

TRA Exemption

schedule 4 min read

Transaction Risk Analysis Exemption

Edit "TRA Exemption" on GitHub

Transaction Risk Analysis Exemption

Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
POST /psp/paymentorders HTTP/1.1
Authorization: Bearer <AccessToken>
Content-Type: application/json

{
    "paymentorder": {
        "requestTraExemption": true
        "payer": {
            "requireConsumerInfo": false,
            "digitalProducts": false,
            "email": "olivia.nyhuus@payex.com",
            "msisdn": "+4798765432",
            "authentication" : {
                "type" : "Digital",
                "method" : "OneFactor",
                "nationalIdentityCardType": null,
                "reference" : null
            },
            "shippingAddress": {
                "firstName": "Olivia",
                "lastName": "Nyhuus",
                "email": "olivia.nyhuus@payex.com",
                "msisdn": "+4798765432",
                "streetAddress": "Saltnestoppen 43",
                "coAddress": "",
                "city": "Saltnes",
                "zipCode": "1642",
                "countryCode": "NO"
              },
              "billingAddress": {
                "firstName": "Olivia",
                "lastName": "Nyhuus",
                "email": "olivia.nyhuus@payex.com",
                "msisdn": "+4798765432",
                "streetAddress": "Saltnestoppen 43",
                "coAddress": "",
                "city": "Saltnes",
                "zipCode": "1642",
                "countryCode": "NO"
              },
              "accountInfo": {
                "accountAgeIndicator": "01",
                "accountChangeIndicator": "01",
                "accountPwdChangeIndicator": "01",
                "shippingAddressUsageIndicator": "01",
                "shippingNameIndicator": "01",
                "suspiciousAccountActivity": "01",
                "addressMatchIndicator": true
              }
        },
        "riskIndicator": {
            "deliveryEmailAddress": "olivia.nyhuus@payex.com",
            "deliveryTimeFrameindicator": "01",
            "preOrderDate": "20210220",
            "preOrderPurchaseIndicator": "01",
            "shipIndicator": "01",
            "giftCardPurchase": false,
            "reOrderPurchaseIndicator": "01",
            "pickUpAddress": {
            "name": "Company Megashop Sarpsborg",
            "streetAddress": "Hundskinnveien 92",
            "coAddress": "",
            "city": "Sarpsborg",
            "zipCode": "1711",
            "countryCode": "NO"
            },
            "items": [
            {
                "gpcNumber": 11220000,
                "amount": 5000
            },
            {
                "gpcNumber": 12340000,
                "amount": 3000
            }
            ]
        }
    }
}
Field Type Description
└➔ paymentorder object The relative URI and unique identifier of the paymentorder resource this payer belongs to. Please read about URI Usage to understand how this and other URIs should be used in your solution.
└➔ requestTraExemption bool Set to true if the merchant requests a TRA exemption.
└➔ payer object The payer object.
└➔ 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 occured.
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.
└➔ 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 likelyhood 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 node 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 node. 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.