Restricted To SSN

Restrict Payments To A Social Security Number

Swedbank Pay provides the possibility to restrict payments to a Social Security Number when the payment methods support this. This can be used when you want to make sure you only accept payments from an already identified individual.

You do this by adding the field restrictedToSocialSecurityNumber in the payer field, in your payment order request, and setting it to true. This will leave out all payment methods which do not support this feature.

It will then use the socialSecurityNumber located in the nationalIdentifier field (found within the payer field). The nationalIdentifier must be included to use this feature. Payment methods supporting the feature will reject payments that do not match the restriction.

If you want to use the Social Security Number just for payment restrictions, and not do a checkout profile lookup, add the parameter guestMode in the nationalIdentifier field and set it to true.

You are currently only able to restrict Swish and Trustly payments to a Social Security Number, but we will add support for more payment methods going forward. No changes are required at your (the merchant’s) end to be able to offer more payment methods at a later time.

Restrict To Social Security Number Request

The field itself is a bool which must be added in the payer field of the request. Below is a shortened example of a payment order request. Apart from the new field, the payment request is similar to a standard payment order request. For an example of a payment order request, click here.
The response will be similar to a standard payment order response, which is also documented on the page linked above.

Request

Copy json to clipboard

1
2
3
4

POST /psp/paymentorders HTTP/1.1
Host: api.externalintegration.payex.com
Authorization: Bearer <AccessToken>
Content-Type: application/json;version=3.x/2.0      // Version optional for 3.0 and 2.0

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

{
    "paymentorder": {
    "payer": {
            "digitalProducts": false,
            "nationalIdentifier": {
                "socialSecurityNumber": "199710202392",
                "countryCode": "SE",
                "guestMode": true
             },
            "restrictedToSocialSecurityNumber": true,
            "firstName": "Leia",
            "lastName": "Ahlström",
            "email": "leia@payex.com",
            "msisdn": "+46787654321",
            "payerReference": "AB1234"
        }
    }
}