Gateway API

The Gateway API component is intended for B2B interfaces it supports REST calls which can board new merchants and request payouts, etc. Most requests are authenticated with the callers merchant or partner API key.

C#PHPNodeShell

Scroll down for code samples, example requests and responses.
Select a language for code samples from the tabs or the mobile navigation menu.

Initiate signup process

POST /partner/v1/onboarding

Parameters

Authorizationstringrequired
Partner API key

Initiate signup process

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

applicationobjectrequired
- countrystringrequired
  DNK, SWE, NOR, GRL, DEU, AUT
- currencystringrequired
- companyobjectrequired
  - organizationNumberstringrequired
  - vatNumberstringoptional
  - invoiceEmailstringoptional
  - contactPersonobjectoptional
    firstNamestringoptional
    lastNamestringoptional
    phonestringoptional
    emailstringoptional
  - companyNamestringoptional
  - companyAddressstringoptional
  - zipCodestringoptional
  - citystringoptional
  - referenceDetailsarrayoptional
    systemstringoptional
    DnB
    referenceKeystringoptional
    DUNS_NO
    referenceValuestringoptional
  - legalTypestringoptional
- productCodesarrayoptional
- salesCodestringoptional
- webshopobjectoptional
  - urlstringoptional
  - namestringoptional
- bankAccountobjectoptional
  - ibanstringoptional
  - swiftstringoptional
- salesRepPartnerstringoptional
- salesRepDibsstringoptional
- quoteobjectoptional
  - documentNostringrequired
  - currencystringrequired
  - signoninteger (int64)required
  - subscriptioninteger (int64)required
  - paymentOptionsarrayrequired
    itemNostringrequired
    paymentTypestringrequired
    CARD, INVOICE, A2A, INSTALLMENT, WALLET
    paymentMethodsarrayrequired
    paymentMethodProviderstringrequired
    Teller, Arvato, SwishSwedbank, Dankort, PayPal, RatePay, Amex, PPRO, NetsAcquiring, ExpressBank, Forbrugsforeningen, Klarna
    optionalbooleanrequired
    selectedbooleanrequired
    feesarrayrequired
    paymentActionTypestringrequired
    CHARGE, REFUND, DA, MOBILEPAY, SWISH, VIPPS, PAYPAL
    feeTypestringrequired
    AMT, TAMT, QTY, TQTY
    unitPriceinteger (int64)required
    priceVATinteger (int64)required
    itemTypestringrequired
    TRANS, SUB
    paymentMethodVariant1stringoptional
    DEBIT, CREDIT
    paymentMethodVariant2stringoptional
    CONSUMER, CORPORATE
    paymentMethodVariant3stringoptional
    EEA, NON-EEA
- amlCustomerIntroductionTypeobjectoptional
  - introductionTypestringrequired
- notificationsobjectoptional
  - webhooksarrayrequired
    eventNamestringrequired
    onboarding.initiated, onboarding.awaiting_signature, onboarding.signature_failed, onboarding.processing, onboarding.approved, onboarding.abandoned
    urlstringrequired
    authorizationstringrequired
merchantIdstringoptional
adminUserobjectrequired
- firstNamestringoptional
- lastNamestringoptional
- emailstringrequired
- languagestringoptional
  EN_US, DA_DK, SV_SE, NO_NO, DE_DE
- sendActivationEmailbooleanoptional

Request body

{
    "application": {
        "country": "DNK",
        "currency": "string",
        "company": {
            "organizationNumber": "string",
            "vatNumber": "string",
            "invoiceEmail": "string",
            "contactPerson": {
                "firstName": "string",
                "lastName": "string",
                "phone": "string",
                "email": "string"
            },
            "companyName": "string",
            "companyAddress": "string",
            "zipCode": "string",
            "city": "string",
            "referenceDetails": [
                {
                    "system": "DnB",
                    "referenceKey": "DUNS_NO",
                    "referenceValue": "string"
                }
            ],
            "legalType": "string"
        },
        "productCodes": [
            "CARD"
        ],
        "salesCode": "string",
        "webshop": {
            "url": "string",
            "name": "string"
        },
        "bankAccount": {
            "iban": "string",
            "swift": "string"
        },
        "salesRepPartner": "string",
        "salesRepDibs": "string",
        "quote": {
            "documentNo": "string",
            "currency": "string",
            "signon": 0,
            "subscription": 0,
            "paymentOptions": [
                {
                    "itemNo": "string",
                    "paymentType": "CARD",
                    "paymentMethods": [
                        "string"
                    ],
                    "paymentMethodProvider": "Teller",
                    "optional": true,
                    "selected": true,
                    "fees": [
                        {
                            "paymentActionType": "CHARGE",
                            "feeType": "AMT",
                            "unitPrice": 0,
                            "priceVAT": 0,
                            "itemType": "TRANS",
                            "paymentMethodVariant1": "DEBIT",
                            "paymentMethodVariant2": "CONSUMER",
                            "paymentMethodVariant3": "EEA"
                        }
                    ]
                }
            ]
        },
        "amlCustomerIntroductionType": {
            "introductionType": "string"
        },
        "notifications": {
            "webhooks": [
                {
                    "eventName": "onboarding.initiated",
                    "url": "string",
                    "authorization": "stringst"
                }
            ]
        }
    },
    "merchantId": "string",
    "adminUser": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "language": "EN_US",
        "sendActivationEmail": true
    }
}

Responses

200SUCCESSoptional
- idinteger (int64)optional
- verificationLinkstringoptional
- merchantIdstringoptional
400Bad Requestoptional
401Unauthorizedoptional
500Unexpected Erroroptional

{
    "id": 0,
    "verificationLink": "string",
    "merchantId": "string"
}

Update signup process for signupId

POST /partner/v1/onboarding/{id}

Parameters

Authorizationstringrequired
Partner API key
idstringrequired
Id of Signup Process to update

Update signup process for signupId

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding/{id}");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

applicationobjectrequired
- countrystringrequired
  DNK, SWE, NOR, GRL, DEU, AUT
- currencystringrequired
- companyobjectrequired
  - organizationNumberstringrequired
  - vatNumberstringoptional
  - invoiceEmailstringoptional
  - contactPersonobjectoptional
    firstNamestringoptional
    lastNamestringoptional
    phonestringoptional
    emailstringoptional
  - companyNamestringoptional
  - companyAddressstringoptional
  - zipCodestringoptional
  - citystringoptional
  - referenceDetailsarrayoptional
    systemstringoptional
    DnB
    referenceKeystringoptional
    DUNS_NO
    referenceValuestringoptional
  - legalTypestringoptional
- productCodesarrayoptional
- salesCodestringoptional
- webshopobjectoptional
  - urlstringoptional
  - namestringoptional
- bankAccountobjectoptional
  - ibanstringoptional
  - swiftstringoptional
- salesRepPartnerstringoptional
- salesRepDibsstringoptional
- quoteobjectoptional
  - documentNostringrequired
  - currencystringrequired
  - signoninteger (int64)required
  - subscriptioninteger (int64)required
  - paymentOptionsarrayrequired
    itemNostringrequired
    paymentTypestringrequired
    CARD, INVOICE, A2A, INSTALLMENT, WALLET
    paymentMethodsarrayrequired
    paymentMethodProviderstringrequired
    Teller, Arvato, SwishSwedbank, Dankort, PayPal, RatePay, Amex, PPRO, NetsAcquiring, ExpressBank, Forbrugsforeningen, Klarna
    optionalbooleanrequired
    selectedbooleanrequired
    feesarrayrequired
    paymentActionTypestringrequired
    CHARGE, REFUND, DA, MOBILEPAY, SWISH, VIPPS, PAYPAL
    feeTypestringrequired
    AMT, TAMT, QTY, TQTY
    unitPriceinteger (int64)required
    priceVATinteger (int64)required
    itemTypestringrequired
    TRANS, SUB
    paymentMethodVariant1stringoptional
    DEBIT, CREDIT
    paymentMethodVariant2stringoptional
    CONSUMER, CORPORATE
    paymentMethodVariant3stringoptional
    EEA, NON-EEA
- amlCustomerIntroductionTypeobjectoptional
  - introductionTypestringrequired
- notificationsobjectoptional
  - webhooksarrayrequired
    eventNamestringrequired
    onboarding.initiated, onboarding.awaiting_signature, onboarding.signature_failed, onboarding.processing, onboarding.approved, onboarding.abandoned
    urlstringrequired
    authorizationstringrequired

Request body

{
    "application": {
        "country": "DNK",
        "currency": "string",
        "company": {
            "organizationNumber": "string",
            "vatNumber": "string",
            "invoiceEmail": "string",
            "contactPerson": {
                "firstName": "string",
                "lastName": "string",
                "phone": "string",
                "email": "string"
            },
            "companyName": "string",
            "companyAddress": "string",
            "zipCode": "string",
            "city": "string",
            "referenceDetails": [
                {
                    "system": "DnB",
                    "referenceKey": "DUNS_NO",
                    "referenceValue": "string"
                }
            ],
            "legalType": "string"
        },
        "productCodes": [
            "CARD"
        ],
        "salesCode": "string",
        "webshop": {
            "url": "string",
            "name": "string"
        },
        "bankAccount": {
            "iban": "string",
            "swift": "string"
        },
        "salesRepPartner": "string",
        "salesRepDibs": "string",
        "quote": {
            "documentNo": "string",
            "currency": "string",
            "signon": 0,
            "subscription": 0,
            "paymentOptions": [
                {
                    "itemNo": "string",
                    "paymentType": "CARD",
                    "paymentMethods": [
                        "string"
                    ],
                    "paymentMethodProvider": "Teller",
                    "optional": true,
                    "selected": true,
                    "fees": [
                        {
                            "paymentActionType": "CHARGE",
                            "feeType": "AMT",
                            "unitPrice": 0,
                            "priceVAT": 0,
                            "itemType": "TRANS",
                            "paymentMethodVariant1": "DEBIT",
                            "paymentMethodVariant2": "CONSUMER",
                            "paymentMethodVariant3": "EEA"
                        }
                    ]
                }
            ]
        },
        "amlCustomerIntroductionType": {
            "introductionType": "string"
        },
        "notifications": {
            "webhooks": [
                {
                    "eventName": "onboarding.initiated",
                    "url": "string",
                    "authorization": "stringst"
                }
            ]
        }
    }
}

Responses

200SUCCESSoptional
400Bad Requestoptional
401Unauthorizedoptional
404Resource Not Foundoptional
500Unexpected Erroroptional

500

"string"

Get signupDetail for signupId

GET /partner/v1/onboarding/{id}

Parameters

Authorizationstringrequired
Partner API key
idstringrequired
Id of needed Signup Process

Get signupDetail for signupId

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding/{id}");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200SUCCESSoptional
- applicationobjectoptional
  - countrystringrequired
    DNK, SWE, NOR, GRL, DEU, AUT
  - currencystringrequired
  - companyobjectrequired
    organizationNumberstringrequired
    vatNumberstringoptional
    invoiceEmailstringoptional
    contactPersonobjectoptional
    firstNamestringoptional
    lastNamestringoptional
    phonestringoptional
    emailstringoptional
    companyNamestringoptional
    companyAddressstringoptional
    zipCodestringoptional
    citystringoptional
    referenceDetailsarrayoptional
    systemstringoptional
    DnB
    referenceKeystringoptional
    DUNS_NO
    referenceValuestringoptional
    legalTypestringoptional
  - productCodesarrayoptional
  - salesCodestringoptional
  - webshopobjectoptional
    urlstringoptional
    namestringoptional
  - bankAccountobjectoptional
    ibanstringoptional
    swiftstringoptional
  - salesRepPartnerstringoptional
  - salesRepDibsstringoptional
  - quoteobjectoptional
    documentNostringrequired
    currencystringrequired
    signoninteger (int64)required
    subscriptioninteger (int64)required
    paymentOptionsarrayrequired
    itemNostringrequired
    paymentTypestringrequired
    CARD, INVOICE, A2A, INSTALLMENT, WALLET
    paymentMethodsarrayrequired
    paymentMethodProviderstringrequired
    Teller, Arvato, SwishSwedbank, Dankort, PayPal, RatePay, Amex, PPRO, NetsAcquiring, ExpressBank, Forbrugsforeningen, Klarna
    optionalbooleanrequired
    selectedbooleanrequired
    feesarrayrequired
    paymentActionTypestringrequired
    CHARGE, REFUND, DA, MOBILEPAY, SWISH, VIPPS, PAYPAL
    feeTypestringrequired
    AMT, TAMT, QTY, TQTY
    unitPriceinteger (int64)required
    priceVATinteger (int64)required
    itemTypestringrequired
    TRANS, SUB
    paymentMethodVariant1stringoptional
    DEBIT, CREDIT
    paymentMethodVariant2stringoptional
    CONSUMER, CORPORATE
    paymentMethodVariant3stringoptional
    EEA, NON-EEA
  - amlCustomerIntroductionTypeobjectoptional
    introductionTypestringrequired
  - notificationsobjectoptional
    webhooksarrayrequired
    eventNamestringrequired
    onboarding.initiated, onboarding.awaiting_signature, onboarding.signature_failed, onboarding.processing, onboarding.approved, onboarding.abandoned
    urlstringrequired
    authorizationstringrequired
- statusstringoptional
  INITIATED, AWAITING_SIGNATURE, SIGNATURE_FAILED, PROCESSING, APPROVED, ABANDONED
- partnerIdstringoptional
- merchantNumberinteger (int64)optional
401Unauthorizedoptional
404Resource Not Foundoptional
500Unexpected Erroroptional

{
    "application": {
        "country": "DNK",
        "currency": "string",
        "company": {
            "organizationNumber": "string",
            "vatNumber": "string",
            "invoiceEmail": "string",
            "contactPerson": {
                "firstName": "string",
                "lastName": "string",
                "phone": "string",
                "email": "string"
            },
            "companyName": "string",
            "companyAddress": "string",
            "zipCode": "string",
            "city": "string",
            "referenceDetails": [
                {
                    "system": "DnB",
                    "referenceKey": "DUNS_NO",
                    "referenceValue": "string"
                }
            ],
            "legalType": "string"
        },
        "productCodes": [
            "CARD"
        ],
        "salesCode": "string",
        "webshop": {
            "url": "string",
            "name": "string"
        },
        "bankAccount": {
            "iban": "string",
            "swift": "string"
        },
        "salesRepPartner": "string",
        "salesRepDibs": "string",
        "quote": {
            "documentNo": "string",
            "currency": "string",
            "signon": 0,
            "subscription": 0,
            "paymentOptions": [
                {
                    "itemNo": "string",
                    "paymentType": "CARD",
                    "paymentMethods": [
                        "string"
                    ],
                    "paymentMethodProvider": "Teller",
                    "optional": true,
                    "selected": true,
                    "fees": [
                        {
                            "paymentActionType": "CHARGE",
                            "feeType": "AMT",
                            "unitPrice": 0,
                            "priceVAT": 0,
                            "itemType": "TRANS",
                            "paymentMethodVariant1": "DEBIT",
                            "paymentMethodVariant2": "CONSUMER",
                            "paymentMethodVariant3": "EEA"
                        }
                    ]
                }
            ]
        },
        "amlCustomerIntroductionType": {
            "introductionType": "string"
        },
        "notifications": {
            "webhooks": [
                {
                    "eventName": "onboarding.initiated",
                    "url": "string",
                    "authorization": "stringst"
                }
            ]
        }
    },
    "status": "INITIATED",
    "partnerId": "string",
    "merchantNumber": 0
}

Resend activation code

POST /partner/v1/onboarding/{id}/resendActivation

Parameters

Authorizationstringrequired
Partner API key
idstringrequired
Partner Id for which activation code to be resent

Resend activation code

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding/{id}/resendActivation");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
IRestResponse response = client.Execute(request);

Responses

200SUCCESSoptional
- codestringoptional
  EMAIL_SENT, USER_ACTIVE, NOT_FOUND, AUTHENTICATION_REQUIRED
- messagestringoptional
401Unauthorizedoptional
404Resource Not Foundoptional
500Unexpected Erroroptional

{
    "code": "EMAIL_SENT",
    "message": "string"
}

Generate test merchant

POST /partner/v1/onboarding/testaccount

Parameters

Authorizationstringrequired
Partner API key

Generate test merchant

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding/testaccount");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

generateUserobjectoptional
- firstNamestringoptional
- lastNamestringoptional
- emailstringrequired
- languagestringoptional
  EN_US, DA_DK, SV_SE, NO_NO, DE_DE
- sendActivationEmailbooleanoptional
- phoneNumberstringrequired

Request body

{
    "generateUser": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "language": "EN_US",
        "sendActivationEmail": true,
        "phoneNumber": "string"
    }
}

Responses

200SUCCESSoptional
- codestringoptional
  EMAIL_SENT, USER_ACTIVE, NOT_FOUND, AUTHENTICATION_REQUIRED
- messagestringoptional
400Bad Requestoptional
401Unauthorizedoptional
500Unexpected Erroroptional

{
    "code": "EMAIL_SENT",
    "message": "string"
}

Create Merchant

POST /partner/v1/onboarding/createMerchant

Parameters

Authorizationstringrequired
Partner API key

Create Merchant

C#
PHP
Node
Shell

var client = new RestClient("https://gateway.pp.easyportal.nets.eu/partner/v1/onboarding/createMerchant");
var request = new RestRequest(Method.POST);
request.AddHeader("content-type", "application/json");
request.AddHeader("Authorization", "REPLACE_KEY_VALUE");
request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

Request body

emailstringrequired
merchantNamestringrequired

Request body

{
    "email": "string",
    "merchantName": "string"
}

Responses

200OKoptional
- resultstringoptional
  SUCCESS, USER_NOT_AUTHORIZED, USER_NOT_FOUND
- idstringoptional
- legalNamestringoptional
400Bad Requestoptional
401Unauthorizedoptional
404Not Foundoptional
- resultstringoptional
  SUCCESS, USER_NOT_AUTHORIZED, USER_NOT_FOUND
- idstringoptional
- legalNamestringoptional
500Unexpected Erroroptional

{
    "result": "SUCCESS",
    "id": "string",
    "legalName": "string"
}