alt

Important information

There was an update of Unzer TLS/SSL certificates. Learn more

Unzer

Check your key configuration

Check your Unzer API key configuration

Overview

You can use /keypair endpoint to check your Unzer API key configuration.

Any requests to the Unzer API must be authenticated by using either your public or private key obtained after signing contract with Unzer. Check the Authentication page for more details.

Get basic information

To look up your public key and all of your configured payment methods, make a GET call to /keypair, using your private key:

POST https://api.unzer.com/v1/keypair
{
    "publicKey": "s-pub-uM8yNmBNcs1GGdwALxxxx",
    "privateKey": "56392899b9833xxxxxx",
    "secureLevel": "SAQ-A",
    "merchantName": "Testmerchant",
    "merchantAddress": "Musterstrasse 1",
    "availablePaymentTypes": [
        "card",
        "sepa-direct-debit-secured",
        "paypal"
    ],
    "coreId": "1234",
    "enableCrossChannelReferencing": "false"
}
Parameter Type Description
publicKey string Your production public key.
privateKey string Your production private key.
secureLevel string Your PCI SAQ level.
availablePaymentTypes Array All of your configured payment methods.

Get a detailed payment methods configuration

To get a detailed view of of your API key configuration, make a GET call to /keypair/types using your private key:

POST https://api.unzer.com/v1/keypair/types
{
    "publicKey": "s-pub-uM8yNmBNcs1GGdwAL4ytebYA4HErE33I",
    "privateKey": "56392899b9833f53d62957c1bc7045f956bad9b075f35aa7fa072d9897f4so6f",
    "secureLevel": "SAQ-A",
    "alias": "myShop",
    "merchantName": "Testmerchant",
    "merchantAddress": "Musterstrasse 1",
    "paymentTypes": [
        {
            "supports": [
                {
                    "brands": [
                        "DISCOVERY",
                        "VISAELECTRON",
                        "MAESTRO",
                        "VISA",
                        "MASTER",
                        "JCB"
                    ],
                    "countries": [],
                    "channel": "31HA07BC819430D3495C56BC18C55622",
                    "currency": [
                        "EUR",
                        "DKK",
                        "CHF",
                        "CNY",
                        "JPY",
                        "USD",
                        "GBP"
                    ]
                }
            ],
            "type": "card",
            "allowCustomerTypes": "B2C,B2B",
            "allowCreditTransaction": false,
            "3ds": true
        },
        {
            "supports": [
                {
                    "brands": [],
                    "countries": [
                        "DE",
                        "AT"
                    ],
                    "channel": "31HA07BC819430D3495C56BC18C55622",
                    "currency": [
                        "EUR"
                    ]
                }
            ],
            "type": "sepa-direct-debit-secured",
            "allowCustomerTypes": "B2C,B2B",
            "allowCreditTransaction": true,
            "3ds": false
        },
        {
            "supports": [
                {
                    "brands": [
                        "PAYPALOT"
                    ],
                    "countries": [],
                    "channel": "31HA07BC8118EAD67DA9A7C8B313E11A",
                    "currency": [
                        "EUR"
                    ]
                }
            ],
            "type": "paypal",
            "allowCustomerTypes": "B2C",
            "allowCreditTransaction": false,
            "3ds": false
        }
    ],
    "coreId": "1234",
    "enableCrossChannelReferencing": "false"
}
Parameter Type Description
publicKey string Your production public key.
privateKey string Your production private key.
secureLevel string Your PCI SAQ level.
alias string Your merchant alias.
paymentTypes object All of your configured payment methods.
supports object Information about a configured payment method.
brands string Brands related to the payment method.
countries string Countries where the payment method is supported.
channel string A channel that identifies the payment method.
currency string ISO currency code: For a list of possible codes, see Amounts and Currencies.
type string The type of the related payment resource.
3ds boolean For cards: if set to true, the card is configured with the 3-D Secure protocol enabled.

For a full description of the /keypair call please refer to API reference

See also

Authentication (API basics)