Skip to content

    Issuing API

    "Welcome to Nets. This document contains the technical description for Nets issuing API v1.0. The Nets Issuing API is REST based and uses ApiKey for authentication. Request body and response are JSON encoded and use the standard HTTP response codes. Below is the brief description of each of the endpoints currently offered by Nets Issuing.

    Introduction

    Authentication

    Each request to Nets Issuing API must be signed with an API key and Authorization header.

    Versioning

    Nets Issuing API supports versioning for its endpoints and can be identified using version suffix in the endpoint URL. The suffix format is "vNN", where NN is the version number. Developers should use the API in a manner that small changes, for example addition of an element to the response data, does not break the implementation.

    For example:

    https://api-gateway.nets.eu/account-service/v1/cards
    

    Definitions

    Description of the entity used in the specification

    EntityDescription
    CustomerThe customer is an entity for an accountholder or a cardholder. It can be linked to one or several accounts and cards. Customer per type is stored only once per institution regardless of the number of linked accounts or cards. Customer data consists of an unique client identification, name, address, contact information, language code, parameters and embossing data. A customer can be a private individual, an employee or a company:

    Customer - Private Resident (PR)

    Business Customer - Corporate Customer (CR)

    Business Customer Company - Corporate Customer (CR)
    AccountAn account, also called an issuing contract, is an entity which holds financial data such as an account contract number, credit limit, different types of balances, account-related status, parameters, and invoicing data. The invoice data includes the minimum payment, interest and statement delivery. For debit products, it holds a link to the bank account. In addition, the account is linked to a client, and card contracts are linked to this specific account.
    CardA card, also called a card contract, is an entity per a card number. The card contract is linked to the account and the client. The card contract holds data related to the card such as card-specific usage limiters, card delivery type, card delivery address and plastic design. There can be multiple plastics under the card contract if the card has been renewed several times with the same card number.
    AddressAddress can be set to a customer, an account or a card. Customer can have a legal and a temporary addresses. The statement address can be set up on the account and the card delivery address to a card.
    TransactionsIssuer information about account and card transactions and also authorisations for cards.
    FeesAdd, update or fetch fees
    PaymentsAdd, update or fetch payments

    Supported products

    EntityDescription
    Credit CardsTo be written
    Debit CardsTo be written
    Combo CardTo be written.
    Virtual CardsTo be written
    Prepaid CardsTo be written
    LoansTo be written

    ISO Language Codes

    The language code in ISO 639-2/T format.

    Language codeLanguage Name
    DANDanish
    ENGEnglish
    FINFinnish
    GERGerman
    NORNorwegian
    SWESwedish

    ISO Country Codes

    The county code in ISO 3166-1 alpha-3 format

    Country codeCountry Name
    ABWAruba
    AFGAfghanistan
    AGOAngola
    AIAAnguilla
    ALAAland Islands
    ALBAlbania
    ANDAndorra
    ANTNetherlands Antilles
    AREUnited Arab Emirates
    ARGArgentina
    ARMArmenia
    ASMAmerican Samoa
    ATAAntarctica
    ATFFrench Southern Territories
    ATGAntigua And Barbuda
    AUSAustralia
    AUTAustria
    AZEAzerbaijan
    BDIBurundi
    BELBelgium
    BENBenin
    BESBonaire, Saint Eustatius and Saba
    BFABurkina Faso
    BGDBangladesh
    BGRBulgaria
    BHRBahrain
    BHSBahamas
    BIHBosnia Herzegovina
    BLRBelarus
    BLZBelize
    BMUBermuda
    BOLBolivia
    BRABrazil
    BRBBarbados
    BRNBrunei Darussalam
    BTNBhutan
    BVTBouvet Island
    BWABotswana
    CAFCentral African Republic
    CANCanada
    CCKCocos (Keeling) Islands
    CDRCongo, The Democratic Republic of
    CHESwitzerland
    CHLChile
    CHNChina
    CIVCote D'Ivoire (Ivory Coast)
    CMRCameroon,United Repuplic
    COGCongo, Republic of the
    COKCook Islands
    COLColombia
    COMComoros
    CPVCape Verde
    CRICosta Rica
    CUBCuba
    CUWCuracao
    CXRChristmas Island
    CYMCayman Islands
    CYPCyprus
    CZECzech Republic
    DEUGermany
    DJIDjibouti
    DMADominica
    DNKDenmark
    DOMDominican Republic
    DZAAlgeria
    ECUEcuador
    EGYEgypt
    ERIEritrea
    ESHWestern Sahara
    ESPSpain
    ESTEstonia
    ETHEthiopia
    FINFinland
    FJIFiji
    FLKFalkland Islands(Malvinas)
    FRAFrance
    FROFaroe Islands
    FSMMicronesia, Federated States of
    GABGabon
    GBRUnited Kingdom
    GEOGeorgia
    GGYGuernsey
    GHAGhana
    GIBGibraltar
    GINGuinea
    GLPGuadeloupe
    GMBGambia
    GNBGuinea-Bissau
    GNQEquatorial Guinea
    GRCGreece
    GRDGrenada
    GRLGreenland
    GTMGuatemala
    GUFFrench Guiana
    GUMGuam
    GUYGuyana
    HKGHong Kong
    HMDHeard and McDonald Islands
    HNDHonduras
    HRVCroatia
    HTIHaiti
    HUNHungary
    IDNIndonesia
    IMNIsle of Man
    INDIndia
    IOTBritish Indian Ocean Territory
    IRLIreland
    IRNIran, Islamic Republic of
    IRQIraq
    ISLIceland
    ISRIsrael
    ITAItaly
    JAMJamaica
    JEYJersey
    JORJordan
    JPNJapan
    KAZKazakhstan
    KENKenya
    KGZKyrgyzstan
    KHMCambodia
    KIRKiribati
    KNASt. Kitts-Nevis
    KORKorea, Republic Of
    KWTKuwait
    LAOLao People's Democratic Republic
    LBNLebanon
    LBRLiberia
    LBYLibyan Arab Jamahiriya
    LCASt. Lucia
    LIELiechtenstein
    LKASri Lanka
    LSOLesotho
    LTULithuania
    LUXLuxembourg
    LVALatvia
    MACMacao
    MARMorocco
    MCOMonaco
    MDAMoldova, Republic Of
    MDVMaldives
    MEXMexico
    MGAMadagascar
    MHLMarshall Islands
    MKDMacedonia
    MLIMali
    MLTMalta
    MMRMyanmar
    MNEMontenegro
    MNGMongolia
    MNPNorthern Mariana Islands
    MOZMozambique
    MRTMauritania
    MSRMontserrat
    MTQMartinique
    MUSMauritius
    MWIMalawi
    MYSMalaysia
    MYTMayotte
    NAMNamibia
    NCLNew Caledonia
    NERNiger
    NFKNorfolk Island
    NGANigeria
    NICNicaragua
    NIUNiue
    NLDNetherlands
    NORNorway
    NPLNepal
    NRUNauru
    NZLNew Zealand
    OMNOman
    PAKPakistan
    PANPanama
    PCNPitcairn Island
    PERPeru
    PHLPhilippines
    PLWPalau
    PNGIndependent State of Papua New Guinea
    POLPoland
    PRIPuerto Rico
    PRKKorea, Democratic People's Republic of
    PRTPortugal
    PRYParaguay
    PSEPalestinian Territory, Occupied
    PYFFrench Polynesia
    QATQatar
    QZZUNMIK
    REUReunion
    ROURomania
    RUSRussia
    RWARwanda
    SAUSaudi Arabia
    SDNSudan
    SENSenegal
    SGPSingapore
    SGSSouth Georgia and the South Sandwich Islands
    SHNSaint Helena, Ascension and Tristan Da Cunha
    SJMSvalbard and Jan Mayen Islands
    SLBSolomon Islands
    SLESierra Leone
    SLVEl Salvador
    SMRSan Marino
    SOMSomalia, Federal Republic of
    SPMSt. Pierre and Miquelon
    SRBSerbia
    SSDSouth Sudan
    STPSao Tome And Principe
    SURSuriname
    SVKSlovakia
    SVNSlovenia
    SWESweden
    SWZSwaziland
    SXMSint Maarten (Dutch part)
    SYCSeychelles
    SYRSyrian Arab Republic
    TCATurks and Caicos Islands
    TCDChad
    TGOTogo
    THAThailand
    TJKTajikistan
    TKLTokelau
    TKMTurkmenistan
    TLSTimor-Leste (East Timor)
    TONTonga
    TTOTrinidad And Tobago
    TUNTunisia
    TURTurkey
    TUVTuvalu
    TWNTaiwan Province Of China
    TZATanzania, United Republic of
    UGAUganda
    UKRUkraine
    UMIU.S. Minor Outlying Islands
    URYUruguay
    USAUnited States
    UZBUzbekistan
    VATVatican City State
    VCTSt. Vincent and the Grenadines
    VENVenezuela
    VGBVirgin Islands, British
    VIRVirgin Islands, U.S.
    VNMVietnam
    VUTVanuatu
    WLFWallis and Futuna Islands
    WSMSamoa
    YEMYemen
    ZAFSouth Africa
    ZMBZambia
    ZWEZimbabwe
    BLMSaint Barthelemy
    CODCongo, The Democratic Republic of Congo
    FXXFrance, Metropolitan
    MAFSaint Martin (French part)
    MDGMADAGASCAR
    ROMROMANIA
    TMPTIMOR-LESTE
    YYYSUDAN - 2
    ZARCONGO, DEMOCRATIC REPUBLIC OF

    ISO Currency Codes

    Currency codeCurrency Name
    191CROATIAN KUNA
    203CZECH KORUNA
    208DANISH KRONE
    233ESTONIAN KROON
    348FORINT
    352ICELAND KRONA
    428LATVIAN LAT
    440LITHUANIAN LITAS
    554NEW ZEALAND DOLLAR
    578NORWEGIAN KRONE
    703SLOVAK KORUNA (old)
    752SWEDISH KRONA
    756SWISS FRANC
    810RUSSIAN ROUBLE
    826POUND STERLING
    840US DOLLAR
    946ROMANIAN LEU
    975NEW LEV
    978EURO
    985NEW POLISH ZLOTY
    999LOYALTY POINT
    004AFGHANI
    008LEK
    012ALGERIAN DINAR
    024ANGOLA KWANZA
    031AZERBAIJANIAN MANAT (old)
    032ARGENTINE PESO
    036AUSTRALIAN DOLLAR
    040AUSTRIA SCHILLING
    044BAHAMIAN DOLLAR
    048BAHRAINI DINAR
    050TAKA
    051DRAM
    052BARBADOS DOLLAR
    056BELGIAN FRANC
    060BERMUDAN DOLLAR
    064BHUTAN NGULTRUM
    068BOLIVIAN PESO
    072PULA
    076CRUZEIRO
    084BELIZE DOLLAR
    090SOLOMON ISLANDS DOLL
    096BRUNEI DOLLAR
    100LEV
    104KYAT
    108BURUNDI FRANC
    112BELARUSSIAN RUBLE (old)
    116RIEL
    124CANADIAN DOLLAR
    132CAPE VERDE ESCUDO
    136CAYMAN ISLANDS DOLLA
    144SRI LANKA RUPEE
    152CHILEAN PESO
    156YUAN RENMINBI
    157OFFSHORE YUAN RENMINBI
    158CHINESE RENMINBI
    170COLOMBIAN PESO
    174COMORO FRANC
    180ZAIRE
    188COSTA RICAN COLON
    192CUBAN PESO
    196CYPRUS POUND
    200KORUNA
    214DOMINICAN PESO
    218SUCRE
    222EL SALVADOR COLON
    226EKWELE
    230ETHIOPIAN BIRR
    232ERITEAN NAKFA
    238FALKLAND ISLANDS POUND
    242FIJI DOLLAR
    246MARKKA
    250FRENCH FRANC
    262DJIBOUTI FRANC
    270DALASI
    278MARK DER DDR
    280DEUTCHE MARK
    288GHANA CEDI
    292GIBRALTAR POUND
    300DRACHMA
    320QUETZAL
    324SYLI
    328GUYANA DOLLAR
    332GOURDE
    340LEMPIRA
    344HONG KONG DOLLAR
    356INDIAN RUPEE
    360RUPIAH
    364IRANIAN RIAL
    368IRAQI DINAR
    372IRISH POUND
    376ISRAEL SHEKEL
    380ITALIAN LIRA
    388JAMAICAN DOLLAR
    392YEN
    398TENGE
    400JORDANIAN DINAR
    404KENYAN SHILLING
    408NORTH KOREAN WON
    410KOREAN WON
    414KUWAITI DINAR
    417SOM
    418KIP
    422LEBANESE POUND
    426LESOTHO LOTI
    430LIBERIAN DOLLAR
    434LIBYAN DINAR
    442LUXEMBOURG FRANC
    446PATACA
    450MALAGASY FRANC
    454MALAWI KWACHA
    458MALAYSIAN RINGGIT
    462MALDIVE RUPEE
    466MALI
    470MALTESE LIRA
    478OUGUIYA (old)
    480MAURITIUS RUPEE
    484MEXICAN PESO
    496TUGRIK
    498MOLDOVAN LEU
    504MORROCCAN DIRHAM
    508MOZAMBIQUE METICAL
    512RIAL OMANI
    516NAMIBIAN DOLLAR
    524NEPALESE RUPEE
    528NETHERLANDS GUILDER
    532NETHERLANDS ANTILLIA GUILDER
    533ARUBAN GUILDER
    548VATU
    558CORDOBA
    566NAIRA
    586PAKISTAN RUPEE
    590BALBOA
    598KINA
    600GUARANI
    604SOL
    608PHILIPPINE PESO
    616ZLOTY
    620PORTUGUESE ESCUDO
    624GUINEA-BISSAU PESO
    626TIMOR ESCUDO
    634QATARI RIAL
    642LEU (old)
    643RUSSIAN ROUBLE
    646RWANDA FRANC
    654ST. HELENA POUND
    678DOBRA
    682SAUDI RIYAL
    690SEYCHELLES RUPEE
    694LEONE
    702SINGAPORE DOLLAR
    704DONG
    705SLOVENIAN TOLAR
    706SOMALI SHILLING
    710RAND
    716ZIMBABWE DOLLAR Old
    720YEMENI DINAR
    724SPANISH PESETA
    728SOUTH SUDANESE POUND
    736SUDANESE POUND
    740SURINAM GUILDER
    748LILANGENI
    760SYRIAN POUND
    762TAJIK RUBLE
    764BAHT
    776PA'ANGA
    780TRINIDAD AND TOBAGO
    784UAE DIRHAM
    788TUNISIAN DINAR
    792OLD TURKISH LIRA
    793PSEUDO TURKISH LIRA
    795MANAT Old
    800UGANDA SHILLING
    804KARBOVANET
    807MACEDONIAN DENAR
    818EGYPTIAN POUND
    834TANZANIAN SHILLING
    858URUGUAYAN PESO
    860UZBEKISTAN SUM
    862BOLIVAR
    882TALA
    886YEMINI RIAL
    890NEW YUGOSLAVIAN DOLL
    891SERBIAN DINAR
    894ZAMBIAN KWACHA (Old)
    901NEW TAIWAN DOLLAR
    928BOLIVAR
    929OUGUIYA
    930DOBRA
    932ZIMBABWE RTGS DOLLAR
    933BELARUSIAN NEW RUBLE
    934MANAT
    935ZIMBABWE DOLLAR
    936GHANA CEDI
    937BOLIVAR(old)
    938SUDANESE POUND
    940URUGUAY PESO
    941SERBIAN DINAR
    943MOZAMBIQUE METICAL (old)
    944AZERBAIJANIAN MANAT
    949TURKISH LIRA
    950CFA FRANC BEAC
    951EAST CARIBBEAN DOLLA
    952CFA FRANC BCEAO
    953CFP FRANC
    967ZAMBIAN KWACHA (New)
    968SURINAMA DOLLAR
    969MALAGASY ARIARY
    971AFGHANI
    972TAJIK SOMONI
    973ANGOLA KWANZA
    974BELARUSSIAN RUBLE
    976FRANC CONGOLAIS
    977BOSNIAN MARKA
    980HRYVNIA
    981LARI
    984BOLIVIAN MVDOL
    986BRAZILIAN REAL (old)
    987CRUZEIRO REAL

    Character Set

    The UTF-8 encoding is supported. The supported characters are shown in the table below.

    Upper-case charactersLower-case charactersUpper-case special charactersLower-case special charactersNumbers
    AaÁá0
    BbÀà1
    CcÂâ2
    DdÃã3
    EeÇç4
    FfÐð5
    GgÉé6
    HhÈè7
    IiÊê8
    JjËë9
    KkÍí
    LlÌì
    MmÎî
    NnÏï
    OoÑñ
    PpÓó
    QqÒò
    RrÔô
    SsÕõ
    TtßÞ
    UuÚþ
    VvÙú
    WwÛù
    XxÜû
    YyÅý
    ZzÄü
    Æå
    Öä
    Øæ
    ö
    ø

    Changelog

    DateDescription
    2022-05-10Draft Version
    2022-05-16Replaced "issuing" to "as" in url path, Arranged the operations based on customer type i.e Private or Commercial.

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

    Private

    Used for the private customer, account and card

    Create a new customer

    POST /institutions/{institutionId}/customers

    Create a new customer in Nets AMS.

    Parameters

    • institutionIdstringrequired

      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

    • X-Request-IDstring (uuid)required

      A universally unique identifier (UUID) for the request message, used for logging purposes.

    • Authorizationstringrequired

      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

    Create a new customer

    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers");
    var request = new RestRequest(Method.POST);
    request.AddHeader("content-type", "application/json");
    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
    request.AddHeader("Authorization", "SOME_STRING_VALUE");
    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
    IRestResponse response = client.Execute(request);

    Request body

    • requestIdstringrequired

      Unique request identification from the issuer in the request.

      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
      • Number must be unique within the institution.
    • customerobjectrequired

      The person's information

      • uniqueIdobjectrequired
        • uniqueRegTypestringoptional

          Reg type defines what is used as a unique person identifier. The corresponding Id is used when retrieving the customer. Possible values:

          • PersonId: When a personId is used as the unique key.
          • AdditionalId: When the additionalId is used as the unique key.

          PersonId, AdditionalId

        • uniqueRegNumberstringrequired

          Unique identification of the customer.

      • additionalIdstringoptional

        Additional identification of the customer.

      • titlestringoptional

        Title of the customer.

        MR, MRS, MIS

      • salutationstringoptional

        Salutation for the customer.

      • firstNamestringrequired

        First name of the customer.

      • middleNamestringoptional

        Middle name of the customer.

      • lastNamestringrequired

        Last name of the customer.

      • languageCodestringoptional

        Preferred language of the customer in ISO 639-2/T format.

      • dateOfBirthstring (date)optional

        Date of birth of the customer in YYYY-MM-DD format.

      • genderstringoptional

        Gender of the customer.

        Male, Female, Other

      • embossingobjectoptional
        • embossingNamestringrequired

          Customer's name as embossed on the card

    Request body

    {
        "requestId": 999020220304124000,
        "customer": {
            "uniqueId": {
                "uniqueRegType": "PersonId",
                "uniqueRegNumber": "200187-355F"
            },
            "additionalId": "INT523355",
            "title": "Mr",
            "salutation": "Doctor",
            "firstName": "Demofirstname",
            "middleName": "Demomiddlename",
            "lastName": "Demolastname",
            "languageCode": "FIN",
            "dateOfBirth": "1985-01-02",
            "gender": "Female",
            "embossing": {
                "embossingName": "EMBOSSING 26CHR"
            }
        }
    }

    Responses

    • 201Createdoptional
      • requestIdstringrequired

        Unique request identification from the issuer in the request.

        • The request-id should start with a 4-digit institution ID unless agreed otherwise.
        • Number must be unique within the institution.
      • uniqueRegNumberstringrequired

        Unique identification of the customer.

      • systemCustomerIdstringoptional

        System generated unique customer identifier .

      • responseStatusobjectrequired

        Response data of the processed request.

        • responseCodeintegerrequired

          Status code of the processed operation request.

        • messagestringoptional

          The description of the status code.

        • serverTimestring (date:time)optional

          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

    • 400Bad requestoptional
      • responseStatusobjectrequired

        The response status of the processed request.

        • responseCodeinteger (int64)required

          Status code of the processed operation request.

        • messagestringoptional

          Description of the response code

        • errorIdstringoptional

          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

        • serverTimestring (date:time)optional

          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

    • 401Unauthorized optional
      • 403Forbidden optional
        • 404Not foundoptional
          • 408Request Timeoutoptional
            • 500Internal Server Erroroptional
              • 502Bad Gatewayoptional
                • 503Service Unavailableoptional
                  • 504Gateway Timeoutoptional

                    201

                    {
                        "requestId": 999020220304124000,
                        "uniqueRegNumber": "200187-355F",
                        "systemCustomerId": "200187-355F",
                        "responseStatus": {
                            "responseCode": 0,
                            "message": "OK",
                            "serverTime": "2019-01-02T12:00:45.201Z"
                        }
                    }

                    Retrieve specific customer details

                    GET /institutions/{institutionId}/customers

                    This operation retrieves specific customer information such as id, name, phone numbers, email address, etc. The uniqueRegNumber used during the customer creation must be passed as a header parameter.

                    Supported operations

                    • Get customer by uniqueRegNumber

                    Parameters

                    • institutionIdstringrequired

                      The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                    • X-Request-IDstring (uuid)required

                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                    • Authorizationstringrequired

                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                    • uniqueRegNumberstringrequired

                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                    Retrieve specific customer details

                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers");
                    var request = new RestRequest(Method.GET);
                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                    IRestResponse response = client.Execute(request);

                    Responses

                    • 200OKoptional
                      • responseStatusobjectoptional

                        Response data of the processed request.

                        • responseCodeintegerrequired

                          Status code of the processed operation request.

                        • messagestringoptional

                          The description of the status code.

                        • serverTimestring (date:time)optional

                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                      • customerobjectrequired

                        The person's information

                        • uniqueIdobjectoptional
                          • uniqueRegTypestringoptional

                            Reg type defines what is used as a unique person identifier. The corresponding Id is used when retrieving the customer. Possible values:

                            • PersonId: When a personId is used as the unique key.
                            • AdditionalId: When the additionalId is used as the unique key.

                            PersonId, AdditionalId

                          • uniqueRegNumberstringrequired

                            Unique identification of the customer.

                        • additionalIdstringoptional

                          Additional identification of the customer.

                        • titlestringoptional

                          Title of the customer.

                          MR, MRS, MIS

                        • salutationstringoptional

                          Salutation for the customer.

                        • firstNamestringrequired

                          First name of the customer.

                        • middleNamestringoptional

                          Middle name of the customer.

                        • lastNamestringrequired

                          Last name of the customer.

                        • languageCodestringoptional

                          Preferred language of the customer in ISO 639-2/T format.

                        • dateOfBirthstring (date)optional

                          Date of birth of the customer in YYYY-MM-DD format.

                        • genderstringoptional

                          Gender of the customer.

                          Male, Female, Other

                        • embossingobjectoptional
                          • embossingNamestringrequired

                            Customer's name as embossed on the card

                        • customerStatusobjectoptional

                          Object for customer status information

                          • codestringrequired

                            Status code of the customer.

                            Active, Inactive, Closed, Deceased

                    • 400Bad requestoptional
                      • responseStatusobjectrequired

                        The response status of the processed request.

                        • responseCodeinteger (int64)required

                          Status code of the processed operation request.

                        • messagestringoptional

                          Description of the response code

                        • errorIdstringoptional

                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                        • serverTimestring (date:time)optional

                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                    • 401Unauthorized optional
                      • 403Forbidden optional
                        • 404Not foundoptional
                          • 408Request Timeoutoptional
                            • 500Internal Server Erroroptional
                              • 502Bad Gatewayoptional
                                • 503Service Unavailableoptional
                                  • 504Gateway Timeoutoptional

                                    200

                                    {
                                        "responseStatus": {
                                            "responseCode": 0,
                                            "message": "OK",
                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                        },
                                        "customer": {
                                            "uniqueId": {
                                                "uniqueRegType": "PersonId",
                                                "uniqueRegNumber": "200187-355F"
                                            },
                                            "additionalId": "INT523355",
                                            "title": "Mr",
                                            "salutation": "Doctor",
                                            "firstName": "Demofirstname",
                                            "middleName": "Demomiddlename",
                                            "lastName": "Demolastname",
                                            "languageCode": "FIN",
                                            "dateOfBirth": "1985-01-02",
                                            "gender": "Female",
                                            "embossing": {
                                                "embossingName": "EMBOSSING 26CHR"
                                            },
                                            "customerStatus": {
                                                "code": "Active"
                                            }
                                        }
                                    }

                                    Retrieve the list of accounts and cards of the customer

                                    GET /institutions/{institutionId}/customers/accounts

                                    This operation retrieves basic account and card information. . The uniqueRegNumber used during the customer creation must be passed as a header parameter. For account details use separate operation: get /institutions/{institutionId}/accounts/account. For card details use separate operation: get /institutions/{institutionId}/cards/card.

                                    Parameters

                                    • institutionIdstringrequired

                                      The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                    • X-Request-IDstring (uuid)required

                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                    • Authorizationstringrequired

                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                    • uniqueRegNumberstringrequired

                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                    Retrieve the list of accounts and cards of the customer

                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/accounts");
                                    var request = new RestRequest(Method.GET);
                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                    IRestResponse response = client.Execute(request);

                                    Responses

                                    • 200OKoptional
                                      • accountsarrayrequired

                                        List of accounts

                                        • branchIdstringoptional

                                          Account branch id. If issuer does not have branches, the institution id is provided here.

                                        • customerInfoobjectrequired
                                          • namestringrequired

                                            Full name of the customer.

                                          • uniqueRegNumberstringoptional

                                            Unique identification of the customer.

                                          • systemCustomerIdstringoptional

                                            System generated unique customer identifier .

                                        • accountContractNumberstringrequired

                                          Unique account contract number.

                                        • issuerAccountIdstringoptional

                                          Issuer assigned Account id. Included in the outgoing file if available.

                                        • productobjectrequired

                                          This is the object for account product

                                          • codestringrequired

                                            The code of the account product. Nets define the institution-specific account product code.

                                          • namestringoptional

                                            Name of the account product code.

                                        • accountStatusobjectrequired

                                          Object for account status information. Valid account statuses:

                                          • S00 = Account OK
                                          • 05 = Account Decline
                                          • S54 = Account to Close
                                          • 114 = Auto-Closed
                                          • codestringrequired

                                            Status code of the account.

                                            S00, 05, S54, 114

                                        • accountOpenDatestring (date)optional

                                          Account open date in YYYY-MM-DD format.

                                        • availableAmountnumber (double)optional

                                          The total available amount.

                                        • balancenumber (double)optional

                                          The total available balance on the account.

                                        • creditLimitnumber (double)optional

                                          Credit limit of the account.

                                        • authorisationHoldsnumber (double)optional

                                          Authorisation hold.

                                        • shadowAuthorisationLimitnumber (double)optional

                                          Extra Authorisation Limit based on the product configuration.

                                        • dueDatestring (date)optional

                                          The due date of the statement in YYYY-MM-DD format.

                                        • lastBillingDatestring (date)optional

                                          The last billing date in YYYY-MM-DD format.

                                        • nextBillingDatestring (date)optional

                                          The next billing date in YYYY-MM-DD format.

                                        • cardsarrayoptional

                                          List of cards for this account

                                          • productobjectrequired

                                            This is the object for card product.

                                            • codestringrequired

                                              The code of the card product. Nets define the institution-specific card product code.

                                            • namestringoptional

                                              Name of the card product.

                                            • bankProductCodestringoptional

                                              This is the extrenal product code used by the issuers.

                                          • cardIdstringrequired

                                            Unique id of the card.

                                          • linkedCardIdstringoptional

                                            For dual PAN card the linked card id is returned in this field.

                                          • maskedCardNumberstringoptional

                                            Masked card number in NNNNNNXXXXXXNNNN format. Depending on the institution's setup, either a card number or a masked card number is provided.

                                          • cardStatusstringrequired

                                            Card status code at the time of retrieving the information. Valid card status codes:

                                            • S00 = Card OK
                                            • 04 = PickUp 04 (General)
                                            • X05 = Card cancelled, preliminary
                                            • 14 = Card Closed
                                            • 41 = PickUp Lost
                                            • 43 = PickUp Stolen
                                            • 47 = Temporary block Fraud Suspicion, Call Issuer
                                            • 51 = PickUp Fraud
                                            • X54 = Card is not valid
                                            • 57 = Temporary block by Bank, Call Issuer
                                            • 99 = Card No Renewal
                                            • 100 = Fraud Suspicious
                                            • 101 = Fraud Suspicious Replace

                                            S00, 04, X05, 14, 41, 43, 47, 51, X54, 57, 99, 100, 101

                                      • responseStatusobjectrequired

                                        Response data of the processed request.

                                        • responseCodeintegerrequired

                                          Status code of the processed operation request.

                                        • messagestringoptional

                                          The description of the status code.

                                        • serverTimestring (date:time)optional

                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                    • 400Bad requestoptional
                                      • responseStatusobjectrequired

                                        The response status of the processed request.

                                        • responseCodeinteger (int64)required

                                          Status code of the processed operation request.

                                        • messagestringoptional

                                          Description of the response code

                                        • errorIdstringoptional

                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                        • serverTimestring (date:time)optional

                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                    • 401Unauthorized optional
                                      • 403Forbidden optional
                                        • 404Not foundoptional
                                          • 408Request Timeoutoptional
                                            • 500Internal Server Erroroptional
                                              • 502Bad Gatewayoptional
                                                • 503Service Unavailableoptional
                                                  • 504Gateway Timeoutoptional

                                                    200

                                                    {
                                                        "accounts": [
                                                            {
                                                                "branchId": 664400,
                                                                "customerInfo": {
                                                                    "name": "Demo Full Name",
                                                                    "uniqueRegNumber": "200187-355F",
                                                                    "systemCustomerId": "200187-355F"
                                                                },
                                                                "accountContractNumber": 990006197714,
                                                                "issuerAccountId": 990006197714,
                                                                "product": {
                                                                    "type": "CREDIT",
                                                                    "code": "990_CRED_PROD",
                                                                    "name": "Nets Demo MC Gold Main"
                                                                },
                                                                "accountStatus": {
                                                                    "code": "S00"
                                                                },
                                                                "accountOpenDate": "2023-01-25",
                                                                "availableAmount": 220.74,
                                                                "balance": -779.26,
                                                                "creditLimit": 10000,
                                                                "authorisationHolds": 100.5,
                                                                "shadowAuthorisationLimit": 150,
                                                                "dueDate": "2019-02-14",
                                                                "lastBillingDate": "2022-002-18",
                                                                "nextBillingDate": "2022-03-17",
                                                                "cards": [
                                                                    {
                                                                        "product": {
                                                                            "code": "990_MC_GOL_C_DMG_P",
                                                                            "name": "Nets Demo MC Gold Main",
                                                                            "bankProductCode": "990_MC_GOL_C_DMG_P"
                                                                        },
                                                                        "cardId": 999011189837890,
                                                                        "linkedCardId": 999011189837891,
                                                                        "maskedCardNumber": "499990XXXXXX8984",
                                                                        "cardStatus": "S00"
                                                                    }
                                                                ]
                                                            }
                                                        ],
                                                        "responseStatus": {
                                                            "responseCode": 0,
                                                            "message": "OK",
                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                        }
                                                    }

                                                    Create a legal address for the new customer.

                                                    POST /institutions/{institutionId}/customers/addresses/legal

                                                    This operation creates a new legal address, phone number and email for a given customer. The unique customer key for creating a new address will be provided as a header parameter.

                                                    Parameters

                                                    • institutionIdstringrequired

                                                      The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                    • X-Request-IDstring (uuid)required

                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                    • Authorizationstringrequired

                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                    • uniqueRegNumberstringrequired

                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                    Create a legal address for the new customer.

                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/addresses/legal");
                                                    var request = new RestRequest(Method.POST);
                                                    request.AddHeader("content-type", "application/json");
                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                    IRestResponse response = client.Execute(request);

                                                    Request body

                                                    • requestIdstringrequired

                                                      Unique request identification from the issuer in the request.

                                                      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                      • Number must be unique within the institution.

                                                    Request body

                                                    {
                                                        "requestId": 999020220304124000,
                                                        "address": {
                                                            "address1": "Address line 1",
                                                            "address2": "Address line 2",
                                                            "address3": "Address line 3",
                                                            "address4": "Address line 4",
                                                            "postalCode": 328,
                                                            "city": "HEL",
                                                            "countryCode": "FIN",
                                                            "municipality": "Helsinki",
                                                            "state": "Uusimaa"
                                                        },
                                                        "contact": {
                                                            "homePhone": "+358234466820",
                                                            "mobilePhone": "+358504466351",
                                                            "workPhone": "+358235227744",
                                                            "email": "test-email@test-company.com"
                                                        }
                                                    }

                                                    Responses

                                                    • 201Createdoptional
                                                      • responseStatusobjectrequired

                                                        Response data of the processed request.

                                                        • responseCodeintegerrequired

                                                          Status code of the processed operation request.

                                                        • messagestringoptional

                                                          The description of the status code.

                                                        • serverTimestring (date:time)optional

                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                      • systemAddressIdstringoptional

                                                        System generated unique identifier of the address.

                                                    • 400Bad requestoptional
                                                      • responseStatusobjectrequired

                                                        The response status of the processed request.

                                                        • responseCodeinteger (int64)required

                                                          Status code of the processed operation request.

                                                        • messagestringoptional

                                                          Description of the response code

                                                        • errorIdstringoptional

                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                        • serverTimestring (date:time)optional

                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                    • 401Unauthorized optional
                                                      • 403Forbidden optional
                                                        • 404Not foundoptional
                                                          • 408Request Timeoutoptional
                                                            • 500Internal Server Erroroptional
                                                              • 502Bad Gatewayoptional
                                                                • 503Service Unavailableoptional
                                                                  • 504Gateway Timeoutoptional

                                                                    201

                                                                    {
                                                                        "responseStatus": {
                                                                            "responseCode": 0,
                                                                            "message": "OK",
                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                        },
                                                                        "systemAddressId": 3234330
                                                                    }
                                                                    PUT /institutions/{institutionId}/customers/addresses/legal/{systemAddressId}

                                                                    This operation updates the full legal address, phone number and email for a given customer. The unique customer key for address update will be provided as a header parameter.

                                                                    • institutionIdstringrequired

                                                                      The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                                    • systemAddressIdnumberrequired

                                                                      Unique identifier of the address in Nets AMS.

                                                                    • X-Request-IDstring (uuid)required

                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                    • Authorizationstringrequired

                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                    • uniqueRegNumberstringrequired

                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                    • requestIdstringrequired

                                                                      Unique request identification from the issuer in the request.

                                                                      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                      • Number must be unique within the institution.

                                                                    Request body

                                                                    {
                                                                        "requestId": 999020220304124000,
                                                                        "address": {
                                                                            "address1": "Address line 1",
                                                                            "address2": "Address line 2",
                                                                            "address3": "Address line 3",
                                                                            "address4": "Address line 4",
                                                                            "postalCode": 328,
                                                                            "city": "HEL",
                                                                            "countryCode": "FIN",
                                                                            "municipality": "Helsinki",
                                                                            "state": "Uusimaa"
                                                                        },
                                                                        "contact": {
                                                                            "homePhone": "+358234466820",
                                                                            "mobilePhone": "+358504466351",
                                                                            "workPhone": "+358235227744",
                                                                            "email": "test-email@test-company.com"
                                                                        }
                                                                    }

                                                                    200

                                                                    {
                                                                        "responseStatus": {
                                                                            "responseCode": 0,
                                                                            "message": "OK",
                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                        },
                                                                        "systemAddressId": 3234330
                                                                    }

                                                                    Create a temporary address for the customer.

                                                                    POST /institutions/{institutionId}/customers/addresses/temporary

                                                                    This operation creates a new temporary address for a given customer. The unique customer key for creating the new address will be provided as a header parameter.

                                                                    Parameters

                                                                    • institutionIdstringrequired

                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                    • X-Request-IDstring (uuid)required

                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                    • Authorizationstringrequired

                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                    • uniqueRegNumberstringrequired

                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                    Create a temporary address for the customer.

                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/addresses/temporary");
                                                                    var request = new RestRequest(Method.POST);
                                                                    request.AddHeader("content-type", "application/json");
                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                    IRestResponse response = client.Execute(request);

                                                                    Request body

                                                                    • requestIdstringrequired

                                                                      Unique request identification from the issuer in the request.

                                                                      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                      • Number must be unique within the institution.

                                                                    Request body

                                                                    {
                                                                        "requestId": 999020220304124000,
                                                                        "address": {
                                                                            "fromDate": "2022-01-08T00:00:00.000Z",
                                                                            "toDate": "2022-01-08T00:00:00.000Z",
                                                                            "address1": "Address line 1",
                                                                            "address2": "Address line 2",
                                                                            "address3": "Address line 3",
                                                                            "address4": "Address line 4",
                                                                            "postalCode": 328,
                                                                            "city": "HEL",
                                                                            "countryCode": "FIN",
                                                                            "municipality": "Helsinki",
                                                                            "state": "Uusimaa"
                                                                        }
                                                                    }

                                                                    Responses

                                                                    • 201Createdoptional
                                                                      • responseStatusobjectrequired

                                                                        Response data of the processed request.

                                                                        • responseCodeintegerrequired

                                                                          Status code of the processed operation request.

                                                                        • messagestringoptional

                                                                          The description of the status code.

                                                                        • serverTimestring (date:time)optional

                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                      • systemAddressIdstringoptional

                                                                        System generated unique identifier of the address.

                                                                    • 400Bad requestoptional
                                                                      • responseStatusobjectrequired

                                                                        The response status of the processed request.

                                                                        • responseCodeinteger (int64)required

                                                                          Status code of the processed operation request.

                                                                        • messagestringoptional

                                                                          Description of the response code

                                                                        • errorIdstringoptional

                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                        • serverTimestring (date:time)optional

                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                    • 401Unauthorized optional
                                                                      • 403Forbidden optional
                                                                        • 404Not foundoptional
                                                                          • 408Request Timeoutoptional
                                                                            • 500Internal Server Erroroptional
                                                                              • 502Bad Gatewayoptional
                                                                                • 503Service Unavailableoptional
                                                                                  • 504Gateway Timeoutoptional

                                                                                    201

                                                                                    {
                                                                                        "responseStatus": {
                                                                                            "responseCode": 0,
                                                                                            "message": "OK",
                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                        },
                                                                                        "systemAddressId": 3234330
                                                                                    }

                                                                                    Update temporary address of the customer.

                                                                                    PUT /institutions/{institutionId}/customers/addresses/temporary/{systemAddressId}

                                                                                    This operation updates the full temporary address for a given customer. The unique customer key for address update will be provided as a header parameter.

                                                                                    Parameters

                                                                                    • institutionIdstringrequired

                                                                                      The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                                                    • systemAddressIdnumberrequired

                                                                                      Unique identifier of the address in Nets AMS.

                                                                                    • X-Request-IDstring (uuid)required

                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                    • Authorizationstringrequired

                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                    • uniqueRegNumberstringrequired

                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                    Update temporary address of the customer.

                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/addresses/temporary/3235030");
                                                                                    var request = new RestRequest(Method.PUT);
                                                                                    request.AddHeader("content-type", "application/json");
                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                    IRestResponse response = client.Execute(request);

                                                                                    Request body

                                                                                    • requestIdstringrequired

                                                                                      Unique request identification from the issuer in the request.

                                                                                      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                      • Number must be unique within the institution.

                                                                                    Request body

                                                                                    {
                                                                                        "requestId": 999020220304124000,
                                                                                        "address": {
                                                                                            "fromDate": "2022-01-08T00:00:00.000Z",
                                                                                            "toDate": "2022-01-08T00:00:00.000Z",
                                                                                            "address1": "Address line 1",
                                                                                            "address2": "Address line 2",
                                                                                            "address3": "Address line 3",
                                                                                            "address4": "Address line 4",
                                                                                            "postalCode": 328,
                                                                                            "city": "HEL",
                                                                                            "countryCode": "FIN",
                                                                                            "municipality": "Helsinki",
                                                                                            "state": "Uusimaa"
                                                                                        }
                                                                                    }

                                                                                    Responses

                                                                                    • 200OKoptional
                                                                                      • responseStatusobjectrequired

                                                                                        Response data of the processed request.

                                                                                        • responseCodeintegerrequired

                                                                                          Status code of the processed operation request.

                                                                                        • messagestringoptional

                                                                                          The description of the status code.

                                                                                        • serverTimestring (date:time)optional

                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                      • systemAddressIdstringoptional

                                                                                        System generated unique identifier of the address.

                                                                                    • 400Bad requestoptional
                                                                                      • responseStatusobjectrequired

                                                                                        The response status of the processed request.

                                                                                        • responseCodeinteger (int64)required

                                                                                          Status code of the processed operation request.

                                                                                        • messagestringoptional

                                                                                          Description of the response code

                                                                                        • errorIdstringoptional

                                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                        • serverTimestring (date:time)optional

                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                    • 401Unauthorized optional
                                                                                      • 403Forbidden optional
                                                                                        • 404Not foundoptional
                                                                                          • 408Request Timeoutoptional
                                                                                            • 500Internal Server Erroroptional
                                                                                              • 502Bad Gatewayoptional
                                                                                                • 503Service Unavailableoptional
                                                                                                  • 504Gateway Timeoutoptional

                                                                                                    200

                                                                                                    {
                                                                                                        "responseStatus": {
                                                                                                            "responseCode": 0,
                                                                                                            "message": "OK",
                                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                        },
                                                                                                        "systemAddressId": 3234330
                                                                                                    }

                                                                                                    Retrieve the list of customer addresses.

                                                                                                    GET /institutions/{institutionId}/customers/addresses

                                                                                                    This operation retrieves list of active and future addreses for the specific customer. The uniqueRegNumber used during the customer creation must be passed as a header parameter. List of addresses includes,

                                                                                                    • Legal address
                                                                                                    • Temporary Address

                                                                                                    Parameters

                                                                                                    • institutionIdstringrequired

                                                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                    • X-Request-IDstring (uuid)required

                                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                    • Authorizationstringrequired

                                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                    • uniqueRegNumberstringrequired

                                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                    Retrieve the list of customer addresses.

                                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/addresses");
                                                                                                    var request = new RestRequest(Method.GET);
                                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                    IRestResponse response = client.Execute(request);

                                                                                                    Responses

                                                                                                    • 200OKoptional
                                                                                                      • addressesarrayrequired

                                                                                                        The list of addresses will be returned if multiple address categories exist for the customer.

                                                                                                        • SystemAddressIdstringoptional

                                                                                                          System generated unique identifier of the address.

                                                                                                        • addressCategorystringrequired

                                                                                                          Address category defines the type of the address. Possible values:

                                                                                                          • LEGAL: Used for permanent address of the customer.
                                                                                                          • TEMPORARY: Used for temporary address of the customer.
                                                                                                          • EMAIL_STATEMENT: Used for statement email address of the customer.

                                                                                                          LEGAL, TEMPORARY, EMAIL_STATEMENT

                                                                                                        • addressundefinedoptional
                                                                                                          • oneOfoptional

                                                                                                            Depending on a certain value, only one of the request bodies below is relevant.

                                                                                                            • optional
                                                                                                              • address1stringoptional

                                                                                                                Address line 1.

                                                                                                              • address2stringoptional

                                                                                                                Address line 2.

                                                                                                              • address3stringoptional

                                                                                                                Address line 3.

                                                                                                              • address4stringoptional

                                                                                                                Address line 4.

                                                                                                              • postalCodestringoptional

                                                                                                                Postal code

                                                                                                              • citystringoptional

                                                                                                                Name of the city

                                                                                                              • countryCodestringoptional

                                                                                                                Country code using ISO 3166-1 alpha-3, e.g. FIN for Finland.

                                                                                                              • municipalitystringoptional

                                                                                                                Muncipality

                                                                                                              • statestringoptional

                                                                                                                State

                                                                                                            • optional
                                                                                                              • fromDatestring (date)optional

                                                                                                                Address effective date in YYYY-MM-DD format.

                                                                                                              • toDatestring (date)optional

                                                                                                                Address expiry date in YYYY-MM-DD format.

                                                                                                        • contactobjectoptional

                                                                                                          The contact details

                                                                                                          • homePhonestringoptional

                                                                                                            Home phone number of the customer. Must be a valid number, only digits with the "+" prefix allowed

                                                                                                          • mobilePhonestringoptional

                                                                                                            Mobile phone number of the customer. Must be a valid number, only digits with the "+" prefix allowed.

                                                                                                          • workPhonestringoptional

                                                                                                            Work phone number of the customer. Must be a valid number, only digits with the "+" prefix allowed

                                                                                                      • responseStatusobjectrequired

                                                                                                        Response data of the processed request.

                                                                                                        • responseCodeintegerrequired

                                                                                                          Status code of the processed operation request.

                                                                                                        • messagestringoptional

                                                                                                          The description of the status code.

                                                                                                        • serverTimestring (date:time)optional

                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                    • 400Bad requestoptional
                                                                                                      • responseStatusobjectrequired

                                                                                                        The response status of the processed request.

                                                                                                        • responseCodeinteger (int64)required

                                                                                                          Status code of the processed operation request.

                                                                                                        • messagestringoptional

                                                                                                          Description of the response code

                                                                                                        • errorIdstringoptional

                                                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                        • serverTimestring (date:time)optional

                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                    • 401Unauthorized optional
                                                                                                      • 403Forbidden optional
                                                                                                        • 404Not foundoptional
                                                                                                          • 408Request Timeoutoptional
                                                                                                            • 500Internal Server Erroroptional
                                                                                                              • 502Bad Gatewayoptional
                                                                                                                • 503Service Unavailableoptional
                                                                                                                  • 504Gateway Timeoutoptional

                                                                                                                    200

                                                                                                                    {
                                                                                                                        "addresses": [
                                                                                                                            {
                                                                                                                                "SystemAddressId": 3234330,
                                                                                                                                "addressCategory": "LEGAL",
                                                                                                                                "address": {
                                                                                                                                    "address1": "Address line 1",
                                                                                                                                    "address2": "Address line 2",
                                                                                                                                    "address3": "Address line 3",
                                                                                                                                    "address4": "Address line 4",
                                                                                                                                    "postalCode": 328,
                                                                                                                                    "city": "HEL",
                                                                                                                                    "countryCode": "FIN",
                                                                                                                                    "municipality": "Helsinki",
                                                                                                                                    "state": "Uusimaa"
                                                                                                                                },
                                                                                                                                "contact": {
                                                                                                                                    "homePhone": "+358234466820",
                                                                                                                                    "mobilePhone": "+358504466351",
                                                                                                                                    "workPhone": "+358235227744",
                                                                                                                                    "email": "test-email@test-company.com"
                                                                                                                                }
                                                                                                                            }
                                                                                                                        ],
                                                                                                                        "responseStatus": {
                                                                                                                            "responseCode": 0,
                                                                                                                            "message": "OK",
                                                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                        }
                                                                                                                    }

                                                                                                                    Retrieve accountholder or cardholder parameters

                                                                                                                    GET /institutions/{institutionId}/customers/parameters

                                                                                                                    This operation is used to retrieve accounholder or cardholder parameters by providing unique registration number as a header parameter.

                                                                                                                    Parameters

                                                                                                                    • institutionIdstringrequired

                                                                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                    • X-Request-IDstring (uuid)required

                                                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                    • Authorizationstringrequired

                                                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                    • uniqueRegNumberstringrequired

                                                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                    Retrieve accountholder or cardholder parameters

                                                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/parameters");
                                                                                                                    var request = new RestRequest(Method.GET);
                                                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                    IRestResponse response = client.Execute(request);

                                                                                                                    Responses

                                                                                                                    • 200OKoptional
                                                                                                                      • responseStatusobjectrequired

                                                                                                                        Response data of the processed request.

                                                                                                                        • responseCodeintegerrequired

                                                                                                                          Status code of the processed operation request.

                                                                                                                        • messagestringoptional

                                                                                                                          The description of the status code.

                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                    • 400Bad requestoptional
                                                                                                                      • responseStatusobjectrequired

                                                                                                                        The response status of the processed request.

                                                                                                                        • responseCodeinteger (int64)required

                                                                                                                          Status code of the processed operation request.

                                                                                                                        • messagestringoptional

                                                                                                                          Description of the response code

                                                                                                                        • errorIdstringoptional

                                                                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                    • 401Unauthorized optional
                                                                                                                      • 403Forbidden optional
                                                                                                                        • 404Not foundoptional
                                                                                                                          • 408Request Timeoutoptional
                                                                                                                            • 500Internal Server Erroroptional
                                                                                                                              • 502Bad Gatewayoptional
                                                                                                                                • 503Service Unavailableoptional
                                                                                                                                  • 504Gateway Timeoutoptional

                                                                                                                                    200

                                                                                                                                    {
                                                                                                                                        "parameters": {
                                                                                                                                            "relationship": "N",
                                                                                                                                            "customerType": "VIP"
                                                                                                                                        },
                                                                                                                                        "responseStatus": {
                                                                                                                                            "responseCode": 0,
                                                                                                                                            "message": "OK",
                                                                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                        }
                                                                                                                                    }

                                                                                                                                    Update customer parameters

                                                                                                                                    PATCH /institutions/{institutionId}/customers/parameters

                                                                                                                                    This operation is used to update parameters for a given accountholder or cardholder. The unique registration number for which the parameters are to be updated will be provided as header parameters.

                                                                                                                                    Parameters

                                                                                                                                    • institutionIdstringrequired

                                                                                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                    • X-Request-IDstring (uuid)required

                                                                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                    • Authorizationstringrequired

                                                                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                    • uniqueRegNumberstringrequired

                                                                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                    Update customer parameters

                                                                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/parameters");
                                                                                                                                    var request = new RestRequest(Method.PATCH);
                                                                                                                                    request.AddHeader("content-type", "application/json");
                                                                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                    IRestResponse response = client.Execute(request);

                                                                                                                                    Request body

                                                                                                                                    • requestIdstringrequired

                                                                                                                                      Unique request identification from the issuer in the request.

                                                                                                                                      • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                      • Number must be unique within the institution.

                                                                                                                                    Request body

                                                                                                                                    {
                                                                                                                                        "requestId": 999020220304124000,
                                                                                                                                        "parameters": {
                                                                                                                                            "relationship": "N",
                                                                                                                                            "customerType": "VIP"
                                                                                                                                        }
                                                                                                                                    }

                                                                                                                                    Responses

                                                                                                                                    • 200OKoptional
                                                                                                                                      • responseStatusobjectrequired

                                                                                                                                        Response data of the processed request.

                                                                                                                                        • responseCodeintegerrequired

                                                                                                                                          Status code of the processed operation request.

                                                                                                                                        • messagestringoptional

                                                                                                                                          The description of the status code.

                                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                    • 400Bad requestoptional
                                                                                                                                      • responseStatusobjectrequired

                                                                                                                                        The response status of the processed request.

                                                                                                                                        • responseCodeinteger (int64)required

                                                                                                                                          Status code of the processed operation request.

                                                                                                                                        • messagestringoptional

                                                                                                                                          Description of the response code

                                                                                                                                        • errorIdstringoptional

                                                                                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                    • 401Unauthorized optional
                                                                                                                                      • 403Forbidden optional
                                                                                                                                        • 404Not foundoptional
                                                                                                                                          • 408Request Timeoutoptional
                                                                                                                                            • 500Internal Server Erroroptional
                                                                                                                                              • 502Bad Gatewayoptional
                                                                                                                                                • 503Service Unavailableoptional
                                                                                                                                                  • 504Gateway Timeoutoptional

                                                                                                                                                    200

                                                                                                                                                    {
                                                                                                                                                        "responseStatus": {
                                                                                                                                                            "responseCode": 0,
                                                                                                                                                            "message": "OK",
                                                                                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                        }
                                                                                                                                                    }

                                                                                                                                                    Creates a new credit account

                                                                                                                                                    POST /institutions/{institutionId}/accounts/credit

                                                                                                                                                    Create credit account operation allows issuers to create a new credit account in Nets AMS.

                                                                                                                                                    Parameters

                                                                                                                                                    • institutionIdstringrequired

                                                                                                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                    • X-Request-IDstring (uuid)required

                                                                                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                    • Authorizationstringrequired

                                                                                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                    • uniqueRegNumberstringrequired

                                                                                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                                    Creates a new credit account

                                                                                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/credit");
                                                                                                                                                    var request = new RestRequest(Method.POST);
                                                                                                                                                    request.AddHeader("content-type", "application/json");
                                                                                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                    IRestResponse response = client.Execute(request);

                                                                                                                                                    Request body

                                                                                                                                                      Responses

                                                                                                                                                      • 201Createdoptional
                                                                                                                                                        • requestIdstringrequired

                                                                                                                                                          Unique request identification from the issuer in the request.

                                                                                                                                                          • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                          • Number must be unique within the institution.
                                                                                                                                                        • accountContractNumberstringrequired

                                                                                                                                                          Unique account contract number.

                                                                                                                                                        • systemAccountIdnumberoptional

                                                                                                                                                          System generated unique account identifier.

                                                                                                                                                        • responseStatusobjectrequired

                                                                                                                                                          Response data of the processed request.

                                                                                                                                                          • responseCodeintegerrequired

                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                          • messagestringoptional

                                                                                                                                                            The description of the status code.

                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                      • 400Bad requestoptional
                                                                                                                                                        • responseStatusobjectrequired

                                                                                                                                                          The response status of the processed request.

                                                                                                                                                          • responseCodeinteger (int64)required

                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                          • messagestringoptional

                                                                                                                                                            Description of the response code

                                                                                                                                                          • errorIdstringoptional

                                                                                                                                                            The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                      • 401Unauthorized optional
                                                                                                                                                        • 403Forbidden optional
                                                                                                                                                          • 404Not foundoptional
                                                                                                                                                            • 408Request Timeoutoptional
                                                                                                                                                              • 500Internal Server Erroroptional
                                                                                                                                                                • 502Bad Gatewayoptional
                                                                                                                                                                  • 503Service Unavailableoptional
                                                                                                                                                                    • 504Gateway Timeoutoptional

                                                                                                                                                                      201

                                                                                                                                                                      {
                                                                                                                                                                          "requestId": 999020220304124000,
                                                                                                                                                                          "accountContractNumber": 990006197714,
                                                                                                                                                                          "systemAccountId": 556647,
                                                                                                                                                                          "responseStatus": {
                                                                                                                                                                              "responseCode": 0,
                                                                                                                                                                              "message": "OK",
                                                                                                                                                                              "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                          }
                                                                                                                                                                      }

                                                                                                                                                                      Set account credit limit

                                                                                                                                                                      PUT /institutions/{institutionId}/accounts/credit/limits/credit

                                                                                                                                                                      Set credit limit for a given account. The accountContractNumber for which the credit limit are to be set will be provided as header parameters.

                                                                                                                                                                      Parameters

                                                                                                                                                                      • institutionIdstringrequired

                                                                                                                                                                        Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                      • X-Request-IDstring (uuid)required

                                                                                                                                                                        A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                      • Authorizationstringrequired

                                                                                                                                                                        Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                      • accountContractNumberstringrequired

                                                                                                                                                                        Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                      Set account credit limit

                                                                                                                                                                      var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/credit/limits/credit");
                                                                                                                                                                      var request = new RestRequest(Method.PUT);
                                                                                                                                                                      request.AddHeader("content-type", "application/json");
                                                                                                                                                                      request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                      request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                      request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                      request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                      IRestResponse response = client.Execute(request);

                                                                                                                                                                      Request body

                                                                                                                                                                      • requestIdstringrequired

                                                                                                                                                                        Unique request identification from the issuer in the request.

                                                                                                                                                                        • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                        • Number must be unique within the institution.
                                                                                                                                                                      • amountnumber (double)required

                                                                                                                                                                        Credit Limit amount to be added.

                                                                                                                                                                      • currencyintegerrequired

                                                                                                                                                                        Three digits ISO-4217 currency code, E.g. "978" for Euro.

                                                                                                                                                                      Request body

                                                                                                                                                                      {
                                                                                                                                                                          "requestId": 999020220304124000,
                                                                                                                                                                          "amount": 648.55,
                                                                                                                                                                          "currency": 986
                                                                                                                                                                      }

                                                                                                                                                                      Responses

                                                                                                                                                                      • 200OKoptional
                                                                                                                                                                        • requestIdobjectoptional

                                                                                                                                                                          Response data of the processed request.

                                                                                                                                                                          • responseCodeintegerrequired

                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                            The description of the status code.

                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                      • 400Bad requestoptional
                                                                                                                                                                        • responseStatusobjectrequired

                                                                                                                                                                          The response status of the processed request.

                                                                                                                                                                          • responseCodeinteger (int64)required

                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                            Description of the response code

                                                                                                                                                                          • errorIdstringoptional

                                                                                                                                                                            The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                      • 401Unauthorized optional
                                                                                                                                                                        • 403Forbidden optional
                                                                                                                                                                          • 404Not foundoptional
                                                                                                                                                                            • 408Request Timeoutoptional
                                                                                                                                                                              • 500Internal Server Erroroptional
                                                                                                                                                                                • 502Bad Gatewayoptional
                                                                                                                                                                                  • 503Service Unavailableoptional
                                                                                                                                                                                    • 504Gateway Timeoutoptional

                                                                                                                                                                                      200

                                                                                                                                                                                      {
                                                                                                                                                                                          "requestId": {
                                                                                                                                                                                              "responseCode": 0,
                                                                                                                                                                                              "message": "OK",
                                                                                                                                                                                              "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                          }
                                                                                                                                                                                      }

                                                                                                                                                                                      Set account temporary limit

                                                                                                                                                                                      PUT /institutions/{institutionId}/accounts/credit/limits/temporary

                                                                                                                                                                                      Set temporary limit for a given account. The accountContractNumber for which the temporary limit are to be set will be provided as header parameters.

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      • institutionIdstringrequired

                                                                                                                                                                                        Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                      • X-Request-IDstring (uuid)required

                                                                                                                                                                                        A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                      • Authorizationstringrequired

                                                                                                                                                                                        Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                      • accountContractNumberstringrequired

                                                                                                                                                                                        Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                      Set account temporary limit

                                                                                                                                                                                      var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/credit/limits/temporary");
                                                                                                                                                                                      var request = new RestRequest(Method.PUT);
                                                                                                                                                                                      request.AddHeader("content-type", "application/json");
                                                                                                                                                                                      request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                      request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                      request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                      request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                      IRestResponse response = client.Execute(request);

                                                                                                                                                                                      Request body

                                                                                                                                                                                      • requestIdstringrequired

                                                                                                                                                                                        Unique request identification from the issuer in the request.

                                                                                                                                                                                        • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                        • Number must be unique within the institution.
                                                                                                                                                                                      • amountnumber (double)required

                                                                                                                                                                                        The amount of the limit.

                                                                                                                                                                                      • currencyintegerrequired

                                                                                                                                                                                        Three digits ISO-4217 currency code, E.g. "978" for Euro.

                                                                                                                                                                                      • fromDatestringoptional

                                                                                                                                                                                        Limit activation date in YYYY-MM-DD format. Applicable only for limit type "TEMP_LIMIT".

                                                                                                                                                                                      • toDatestring (date)required

                                                                                                                                                                                        Limit expiration date in YYYY-MM-DD format. Applicable only for limit type "TEMP_LIMIT".

                                                                                                                                                                                      Request body

                                                                                                                                                                                      {
                                                                                                                                                                                          "requestId": 999020220304124000,
                                                                                                                                                                                          "amount": 648.55,
                                                                                                                                                                                          "currency": 986,
                                                                                                                                                                                          "fromDate": "2022-11-15",
                                                                                                                                                                                          "toDate": "2023-01-31"
                                                                                                                                                                                      }

                                                                                                                                                                                      Responses

                                                                                                                                                                                      • 200OKoptional
                                                                                                                                                                                        • requestIdobjectoptional

                                                                                                                                                                                          Response data of the processed request.

                                                                                                                                                                                          • responseCodeintegerrequired

                                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                                            The description of the status code.

                                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                      • 400Bad requestoptional
                                                                                                                                                                                        • responseStatusobjectrequired

                                                                                                                                                                                          The response status of the processed request.

                                                                                                                                                                                          • responseCodeinteger (int64)required

                                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                                            Description of the response code

                                                                                                                                                                                          • errorIdstringoptional

                                                                                                                                                                                            The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                      • 401Unauthorized optional
                                                                                                                                                                                        • 403Forbidden optional
                                                                                                                                                                                          • 404Not foundoptional
                                                                                                                                                                                            • 408Request Timeoutoptional
                                                                                                                                                                                              • 500Internal Server Erroroptional
                                                                                                                                                                                                • 502Bad Gatewayoptional
                                                                                                                                                                                                  • 503Service Unavailableoptional
                                                                                                                                                                                                    • 504Gateway Timeoutoptional

                                                                                                                                                                                                      200

                                                                                                                                                                                                      {
                                                                                                                                                                                                          "requestId": {
                                                                                                                                                                                                              "responseCode": 0,
                                                                                                                                                                                                              "message": "OK",
                                                                                                                                                                                                              "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                      }

                                                                                                                                                                                                      Creates a new debit account

                                                                                                                                                                                                      POST /institutions/{institutionId}/accounts/debit

                                                                                                                                                                                                      Create debit account operation allows issuers to create a new debit account in Nets AMS.

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      • institutionIdstringrequired

                                                                                                                                                                                                        Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                      • X-Request-IDstring (uuid)required

                                                                                                                                                                                                        A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                      • Authorizationstringrequired

                                                                                                                                                                                                        Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                      • uniqueRegNumberstringrequired

                                                                                                                                                                                                        Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                                                                                      Creates a new debit account

                                                                                                                                                                                                      var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/debit");
                                                                                                                                                                                                      var request = new RestRequest(Method.POST);
                                                                                                                                                                                                      request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                      request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                      request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                      request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                      request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                      IRestResponse response = client.Execute(request);

                                                                                                                                                                                                      Request body

                                                                                                                                                                                                        Responses

                                                                                                                                                                                                        • 201Createdoptional
                                                                                                                                                                                                          • requestIdstringrequired

                                                                                                                                                                                                            Unique request identification from the issuer in the request.

                                                                                                                                                                                                            • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                            • Number must be unique within the institution.
                                                                                                                                                                                                          • accountContractNumberstringrequired

                                                                                                                                                                                                            Unique account contract number.

                                                                                                                                                                                                          • systemAccountIdnumberoptional

                                                                                                                                                                                                            System generated unique account identifier.

                                                                                                                                                                                                          • responseStatusobjectrequired

                                                                                                                                                                                                            Response data of the processed request.

                                                                                                                                                                                                            • responseCodeintegerrequired

                                                                                                                                                                                                              Status code of the processed operation request.

                                                                                                                                                                                                            • messagestringoptional

                                                                                                                                                                                                              The description of the status code.

                                                                                                                                                                                                            • serverTimestring (date:time)optional

                                                                                                                                                                                                              Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                        • 400Bad requestoptional
                                                                                                                                                                                                          • responseStatusobjectrequired

                                                                                                                                                                                                            The response status of the processed request.

                                                                                                                                                                                                            • responseCodeinteger (int64)required

                                                                                                                                                                                                              Status code of the processed operation request.

                                                                                                                                                                                                            • messagestringoptional

                                                                                                                                                                                                              Description of the response code

                                                                                                                                                                                                            • errorIdstringoptional

                                                                                                                                                                                                              The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                            • serverTimestring (date:time)optional

                                                                                                                                                                                                              Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                        • 401Unauthorized optional
                                                                                                                                                                                                          • 403Forbidden optional
                                                                                                                                                                                                            • 404Not foundoptional
                                                                                                                                                                                                              • 408Request Timeoutoptional
                                                                                                                                                                                                                • 500Internal Server Erroroptional
                                                                                                                                                                                                                  • 502Bad Gatewayoptional
                                                                                                                                                                                                                    • 503Service Unavailableoptional
                                                                                                                                                                                                                      • 504Gateway Timeoutoptional

                                                                                                                                                                                                                        201

                                                                                                                                                                                                                        {
                                                                                                                                                                                                                            "requestId": 999020220304124000,
                                                                                                                                                                                                                            "accountContractNumber": 990006197714,
                                                                                                                                                                                                                            "systemAccountId": 556647,
                                                                                                                                                                                                                            "responseStatus": {
                                                                                                                                                                                                                                "responseCode": 0,
                                                                                                                                                                                                                                "message": "OK",
                                                                                                                                                                                                                                "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                        }

                                                                                                                                                                                                                        Creates a new loan account

                                                                                                                                                                                                                        POST /institutions/{institutionId}/accounts/loan

                                                                                                                                                                                                                        Create loan Account operation allows issuers to create a new consumer loan account in Nets AMS.

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        • institutionIdstringrequired

                                                                                                                                                                                                                          Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                        • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                          A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                        • Authorizationstringrequired

                                                                                                                                                                                                                          Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                        • uniqueRegNumberstringrequired

                                                                                                                                                                                                                          Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                                                                                                        Creates a new loan account

                                                                                                                                                                                                                        var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/loan");
                                                                                                                                                                                                                        var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                        request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                        request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                        request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                        request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                        request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                        IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                        Request body

                                                                                                                                                                                                                          Responses

                                                                                                                                                                                                                          • 201Createdoptional
                                                                                                                                                                                                                            • requestIdstringrequired

                                                                                                                                                                                                                              Unique request identification from the issuer in the request.

                                                                                                                                                                                                                              • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                              • Number must be unique within the institution.
                                                                                                                                                                                                                            • accountContractNumberstringrequired

                                                                                                                                                                                                                              Unique account contract number.

                                                                                                                                                                                                                            • systemAccountIdnumberoptional

                                                                                                                                                                                                                              System generated unique account identifier.

                                                                                                                                                                                                                            • responseStatusobjectrequired

                                                                                                                                                                                                                              Response data of the processed request.

                                                                                                                                                                                                                              • responseCodeintegerrequired

                                                                                                                                                                                                                                Status code of the processed operation request.

                                                                                                                                                                                                                              • messagestringoptional

                                                                                                                                                                                                                                The description of the status code.

                                                                                                                                                                                                                              • serverTimestring (date:time)optional

                                                                                                                                                                                                                                Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                          • 400Bad requestoptional
                                                                                                                                                                                                                            • responseStatusobjectrequired

                                                                                                                                                                                                                              The response status of the processed request.

                                                                                                                                                                                                                              • responseCodeinteger (int64)required

                                                                                                                                                                                                                                Status code of the processed operation request.

                                                                                                                                                                                                                              • messagestringoptional

                                                                                                                                                                                                                                Description of the response code

                                                                                                                                                                                                                              • errorIdstringoptional

                                                                                                                                                                                                                                The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                              • serverTimestring (date:time)optional

                                                                                                                                                                                                                                Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                          • 401Unauthorized optional
                                                                                                                                                                                                                            • 403Forbidden optional
                                                                                                                                                                                                                              • 404Not foundoptional
                                                                                                                                                                                                                                • 408Request Timeoutoptional
                                                                                                                                                                                                                                  • 500Internal Server Erroroptional
                                                                                                                                                                                                                                    • 502Bad Gatewayoptional
                                                                                                                                                                                                                                      • 503Service Unavailableoptional
                                                                                                                                                                                                                                        • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                          201

                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                              "requestId": 999020220304124000,
                                                                                                                                                                                                                                              "accountContractNumber": 990006197714,
                                                                                                                                                                                                                                              "systemAccountId": 556647,
                                                                                                                                                                                                                                              "responseStatus": {
                                                                                                                                                                                                                                                  "responseCode": 0,
                                                                                                                                                                                                                                                  "message": "OK",
                                                                                                                                                                                                                                                  "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Set account instalment limit

                                                                                                                                                                                                                                          PUT /institutions/{institutionId}/accounts/loans/limits/instalment

                                                                                                                                                                                                                                          Set instalment limit for a given account. The accountContractNumber for which the instalment limit are to be added will be provided as header parameters.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • institutionIdstringrequired

                                                                                                                                                                                                                                            Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                          • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                            A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                          • Authorizationstringrequired

                                                                                                                                                                                                                                            Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                          • accountContractNumberstringrequired

                                                                                                                                                                                                                                            Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                          Set account instalment limit

                                                                                                                                                                                                                                          var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/loans/limits/instalment");
                                                                                                                                                                                                                                          var request = new RestRequest(Method.PUT);
                                                                                                                                                                                                                                          request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                          request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                          request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                          request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                          request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                          IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                          Request body

                                                                                                                                                                                                                                          • requestIdstringrequired

                                                                                                                                                                                                                                            Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                            • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                            • Number must be unique within the institution.
                                                                                                                                                                                                                                          • amountnumber (double)required

                                                                                                                                                                                                                                            The amount of the limit.

                                                                                                                                                                                                                                          • currencyintegerrequired

                                                                                                                                                                                                                                            Three digits ISO-4217 currency code, E.g. "978" for Euro.

                                                                                                                                                                                                                                          Request body

                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                              "requestId": 999020220304124000,
                                                                                                                                                                                                                                              "amount": 648.55,
                                                                                                                                                                                                                                              "currency": 986
                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                          Responses

                                                                                                                                                                                                                                          • 200OKoptional
                                                                                                                                                                                                                                            • requestIdobjectoptional

                                                                                                                                                                                                                                              Response data of the processed request.

                                                                                                                                                                                                                                              • responseCodeintegerrequired

                                                                                                                                                                                                                                                Status code of the processed operation request.

                                                                                                                                                                                                                                              • messagestringoptional

                                                                                                                                                                                                                                                The description of the status code.

                                                                                                                                                                                                                                              • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                          • 400Bad requestoptional
                                                                                                                                                                                                                                            • responseStatusobjectrequired

                                                                                                                                                                                                                                              The response status of the processed request.

                                                                                                                                                                                                                                              • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                Status code of the processed operation request.

                                                                                                                                                                                                                                              • messagestringoptional

                                                                                                                                                                                                                                                Description of the response code

                                                                                                                                                                                                                                              • errorIdstringoptional

                                                                                                                                                                                                                                                The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                              • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                          • 401Unauthorized optional
                                                                                                                                                                                                                                            • 403Forbidden optional
                                                                                                                                                                                                                                              • 404Not foundoptional
                                                                                                                                                                                                                                                • 408Request Timeoutoptional
                                                                                                                                                                                                                                                  • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                    • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                      • 503Service Unavailableoptional
                                                                                                                                                                                                                                                        • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                          200

                                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                                              "requestId": {
                                                                                                                                                                                                                                                                  "responseCode": 0,
                                                                                                                                                                                                                                                                  "message": "OK",
                                                                                                                                                                                                                                                                  "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                          Creates a new prepaid account

                                                                                                                                                                                                                                                          POST /institutions/{institutionId}/accounts/prepaid

                                                                                                                                                                                                                                                          Create Prepaid Account operation allows issuers to create a new prepaid account in Nets AMS.

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          • institutionIdstringrequired

                                                                                                                                                                                                                                                            Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                          • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                            A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                          • Authorizationstringrequired

                                                                                                                                                                                                                                                            Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                          • uniqueRegNumberstringrequired

                                                                                                                                                                                                                                                            Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                                                                                                                                          Creates a new prepaid account

                                                                                                                                                                                                                                                          var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/prepaid");
                                                                                                                                                                                                                                                          var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                                                          request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                          request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                          request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                          request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                          request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                          IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                          Request body

                                                                                                                                                                                                                                                            Responses

                                                                                                                                                                                                                                                            • 201Createdoptional
                                                                                                                                                                                                                                                              • requestIdstringrequired

                                                                                                                                                                                                                                                                Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                                                • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                                                • Number must be unique within the institution.
                                                                                                                                                                                                                                                              • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                Unique account contract number.

                                                                                                                                                                                                                                                              • systemAccountIdnumberoptional

                                                                                                                                                                                                                                                                System generated unique account identifier.

                                                                                                                                                                                                                                                              • responseStatusobjectrequired

                                                                                                                                                                                                                                                                Response data of the processed request.

                                                                                                                                                                                                                                                                • responseCodeintegerrequired

                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                  The description of the status code.

                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                            • 400Bad requestoptional
                                                                                                                                                                                                                                                              • responseStatusobjectrequired

                                                                                                                                                                                                                                                                The response status of the processed request.

                                                                                                                                                                                                                                                                • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                  Description of the response code

                                                                                                                                                                                                                                                                • errorIdstringoptional

                                                                                                                                                                                                                                                                  The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                            • 401Unauthorized optional
                                                                                                                                                                                                                                                              • 403Forbidden optional
                                                                                                                                                                                                                                                                • 404Not foundoptional
                                                                                                                                                                                                                                                                  • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                    • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                      • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                        • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                          • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                            201

                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                "requestId": 999020220304124000,
                                                                                                                                                                                                                                                                                "accountContractNumber": 990006197714,
                                                                                                                                                                                                                                                                                "systemAccountId": 556647,
                                                                                                                                                                                                                                                                                "responseStatus": {
                                                                                                                                                                                                                                                                                    "responseCode": 0,
                                                                                                                                                                                                                                                                                    "message": "OK",
                                                                                                                                                                                                                                                                                    "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                            Retrieve specific account detail

                                                                                                                                                                                                                                                                            GET /institutions/{institutionId}/accounts/account

                                                                                                                                                                                                                                                                            Can we add customer name and customer Id? This operation retrieves account information such as account number, product, status, balances and statement summary for a given account number.

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            • institutionIdstringrequired

                                                                                                                                                                                                                                                                              The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                                                                                                                                                                                                                                            • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                              A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                            • Authorizationstringrequired

                                                                                                                                                                                                                                                                              Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                            • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                              Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                            Retrieve specific account detail

                                                                                                                                                                                                                                                                            var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/account");
                                                                                                                                                                                                                                                                            var request = new RestRequest(Method.GET);
                                                                                                                                                                                                                                                                            request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                            request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                            request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                            IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                            Responses

                                                                                                                                                                                                                                                                            • 200OKoptional
                                                                                                                                                                                                                                                                              • accountobjectrequired

                                                                                                                                                                                                                                                                                The detail of the account related information to be returned when get account endpoint is used.

                                                                                                                                                                                                                                                                                • branchIdstringoptional

                                                                                                                                                                                                                                                                                  Account branch id. If issuer does not have branches, the institution id is provided here.

                                                                                                                                                                                                                                                                                • customerInfoobjectrequired
                                                                                                                                                                                                                                                                                  • namestringrequired

                                                                                                                                                                                                                                                                                    Full name of the customer.

                                                                                                                                                                                                                                                                                  • uniqueRegNumberstringoptional

                                                                                                                                                                                                                                                                                    Unique identification of the customer.

                                                                                                                                                                                                                                                                                  • systemCustomerIdstringoptional

                                                                                                                                                                                                                                                                                    System generated unique customer identifier .

                                                                                                                                                                                                                                                                                • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                  Unique account contract number.

                                                                                                                                                                                                                                                                                • issuerAccountIdstringoptional

                                                                                                                                                                                                                                                                                  Issuer assigned Account id. Included in the outgoing file if available.

                                                                                                                                                                                                                                                                                • productobjectrequired

                                                                                                                                                                                                                                                                                  This is the object for account product

                                                                                                                                                                                                                                                                                  • codestringrequired

                                                                                                                                                                                                                                                                                    The code of the account product. Nets define the institution-specific account product code.

                                                                                                                                                                                                                                                                                  • namestringoptional

                                                                                                                                                                                                                                                                                    Name of the account product code.

                                                                                                                                                                                                                                                                                • accountStatusobjectrequired

                                                                                                                                                                                                                                                                                  Object for account status information. Valid account statuses:

                                                                                                                                                                                                                                                                                  • S00 = Account OK
                                                                                                                                                                                                                                                                                  • 05 = Account Decline
                                                                                                                                                                                                                                                                                  • S54 = Account to Close
                                                                                                                                                                                                                                                                                  • 114 = Auto-Closed
                                                                                                                                                                                                                                                                                  • codestringrequired

                                                                                                                                                                                                                                                                                    Status code of the account.

                                                                                                                                                                                                                                                                                    S00, 05, S54, 114

                                                                                                                                                                                                                                                                                • accountOpenDatestring (date)optional

                                                                                                                                                                                                                                                                                  Account open date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                • availableAmountnumber (double)optional

                                                                                                                                                                                                                                                                                  The total available amount.

                                                                                                                                                                                                                                                                                • balancenumber (double)optional

                                                                                                                                                                                                                                                                                  The total available balance on the account.

                                                                                                                                                                                                                                                                                • creditLimitnumber (double)optional

                                                                                                                                                                                                                                                                                  Credit limit of the account.

                                                                                                                                                                                                                                                                                • authorisationHoldsnumber (double)optional

                                                                                                                                                                                                                                                                                  Authorisation hold.

                                                                                                                                                                                                                                                                                • shadowAuthorisationLimitnumber (double)optional

                                                                                                                                                                                                                                                                                  Extra Authorisation Limit based on the product configuration.

                                                                                                                                                                                                                                                                                • dueDatestring (date)optional

                                                                                                                                                                                                                                                                                  The due date of the statement in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                • lastBillingDatestring (date)optional

                                                                                                                                                                                                                                                                                  The last billing date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                • nextBillingDatestring (date)optional

                                                                                                                                                                                                                                                                                  The next billing date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                              • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                Response data of the processed request.

                                                                                                                                                                                                                                                                                • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                                  The description of the status code.

                                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                            • 400Bad requestoptional
                                                                                                                                                                                                                                                                              • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                The response status of the processed request.

                                                                                                                                                                                                                                                                                • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                                  Description of the response code

                                                                                                                                                                                                                                                                                • errorIdstringoptional

                                                                                                                                                                                                                                                                                  The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                            • 401Unauthorized optional
                                                                                                                                                                                                                                                                              • 403Forbidden optional
                                                                                                                                                                                                                                                                                • 404Not foundoptional
                                                                                                                                                                                                                                                                                  • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                    • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                      • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                        • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                          • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                            200

                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                "account": {
                                                                                                                                                                                                                                                                                                    "branchId": 664400,
                                                                                                                                                                                                                                                                                                    "customerInfo": {
                                                                                                                                                                                                                                                                                                        "name": "Demo Full Name",
                                                                                                                                                                                                                                                                                                        "uniqueRegNumber": "200187-355F",
                                                                                                                                                                                                                                                                                                        "systemCustomerId": "200187-355F"
                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                    "accountContractNumber": 990006197714,
                                                                                                                                                                                                                                                                                                    "issuerAccountId": 990006197714,
                                                                                                                                                                                                                                                                                                    "product": {
                                                                                                                                                                                                                                                                                                        "type": "CREDIT",
                                                                                                                                                                                                                                                                                                        "code": "990_CRED_PROD",
                                                                                                                                                                                                                                                                                                        "name": "Nets Demo MC Gold Main"
                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                    "accountStatus": {
                                                                                                                                                                                                                                                                                                        "code": "S00"
                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                    "accountOpenDate": "2023-01-25",
                                                                                                                                                                                                                                                                                                    "availableAmount": 220.74,
                                                                                                                                                                                                                                                                                                    "balance": -779.26,
                                                                                                                                                                                                                                                                                                    "creditLimit": 10000,
                                                                                                                                                                                                                                                                                                    "authorisationHolds": 100.5,
                                                                                                                                                                                                                                                                                                    "shadowAuthorisationLimit": 150,
                                                                                                                                                                                                                                                                                                    "dueDate": "2019-02-14",
                                                                                                                                                                                                                                                                                                    "lastBillingDate": "2022-002-18",
                                                                                                                                                                                                                                                                                                    "nextBillingDate": "2022-03-17"
                                                                                                                                                                                                                                                                                                },
                                                                                                                                                                                                                                                                                                "responseStatus": {
                                                                                                                                                                                                                                                                                                    "responseCode": 0,
                                                                                                                                                                                                                                                                                                    "message": "OK",
                                                                                                                                                                                                                                                                                                    "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Set a minimum amount to pay

                                                                                                                                                                                                                                                                                            PUT /institutions/{institutionId}/accounts/minimum-payment

                                                                                                                                                                                                                                                                                            Sets a minimum amount to pay for a given account. The accountContractNumber for which the minimum amount to pay are to be set will be provided as header parameters.

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            • institutionIdstringrequired

                                                                                                                                                                                                                                                                                              Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                            • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                              A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                            • Authorizationstringrequired

                                                                                                                                                                                                                                                                                              Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                            • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                              Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                            Set a minimum amount to pay

                                                                                                                                                                                                                                                                                            var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/minimum-payment");
                                                                                                                                                                                                                                                                                            var request = new RestRequest(Method.PUT);
                                                                                                                                                                                                                                                                                            request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                            request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                            request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                            request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                            request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                            IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                            Request body

                                                                                                                                                                                                                                                                                            • requestIdstringrequired

                                                                                                                                                                                                                                                                                              Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                                                                              • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                                                                              • Number must be unique within the institution.
                                                                                                                                                                                                                                                                                            • amountnumber (double)required

                                                                                                                                                                                                                                                                                              Minimum Payment amount.

                                                                                                                                                                                                                                                                                            • percentagenumber (double)required

                                                                                                                                                                                                                                                                                              Minimum Payment percentages.

                                                                                                                                                                                                                                                                                            Request body

                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                "requestId": 999020220304124000,
                                                                                                                                                                                                                                                                                                "amount": 648.55,
                                                                                                                                                                                                                                                                                                "percentage": 648.55
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Responses

                                                                                                                                                                                                                                                                                            • 200OKoptional
                                                                                                                                                                                                                                                                                              • requestIdobjectoptional

                                                                                                                                                                                                                                                                                                Response data of the processed request.

                                                                                                                                                                                                                                                                                                • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                                                  The description of the status code.

                                                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                            • 400Bad requestoptional
                                                                                                                                                                                                                                                                                              • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                The response status of the processed request.

                                                                                                                                                                                                                                                                                                • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                  Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                • messagestringoptional

                                                                                                                                                                                                                                                                                                  Description of the response code

                                                                                                                                                                                                                                                                                                • errorIdstringoptional

                                                                                                                                                                                                                                                                                                  The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                  Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                            • 401Unauthorized optional
                                                                                                                                                                                                                                                                                              • 403Forbidden optional
                                                                                                                                                                                                                                                                                                • 404Not foundoptional
                                                                                                                                                                                                                                                                                                  • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                    • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                      • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                        • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                          • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                            200

                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                "requestId": {
                                                                                                                                                                                                                                                                                                                    "responseCode": 0,
                                                                                                                                                                                                                                                                                                                    "message": "OK",
                                                                                                                                                                                                                                                                                                                    "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Create a new statement address of the account.

                                                                                                                                                                                                                                                                                                            POST /institutions/{institutionId}/accounts/addresses/statement

                                                                                                                                                                                                                                                                                                            This operation creates a new statement address and email for a given account. The account number for creating a new address will be provided as a header parameter.

                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                            • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                              The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                                                                                                                                                                                                                                                                            • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                              A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                            • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                              Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                            • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                              Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                            Create a new statement address of the account.

                                                                                                                                                                                                                                                                                                            var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/addresses/statement");
                                                                                                                                                                                                                                                                                                            var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                                                                                                            request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                            request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                            request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                            request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                            request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                            IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                            Request body

                                                                                                                                                                                                                                                                                                            • requestIdstringrequired

                                                                                                                                                                                                                                                                                                              Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                                                                                              • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                                                                                              • Number must be unique within the institution.
                                                                                                                                                                                                                                                                                                            • addressobjectoptional

                                                                                                                                                                                                                                                                                                              The generic address fields

                                                                                                                                                                                                                                                                                                              • address1stringrequired

                                                                                                                                                                                                                                                                                                                Address line 1.

                                                                                                                                                                                                                                                                                                              • address2stringoptional

                                                                                                                                                                                                                                                                                                                Address line 2.

                                                                                                                                                                                                                                                                                                              • address3stringoptional

                                                                                                                                                                                                                                                                                                                Address line 3.

                                                                                                                                                                                                                                                                                                              • address4stringoptional

                                                                                                                                                                                                                                                                                                                Address line 4.

                                                                                                                                                                                                                                                                                                              • postalCodestringoptional

                                                                                                                                                                                                                                                                                                                Postal code

                                                                                                                                                                                                                                                                                                              • citystringrequired

                                                                                                                                                                                                                                                                                                                Name of the city

                                                                                                                                                                                                                                                                                                              • countryCodestringrequired

                                                                                                                                                                                                                                                                                                                Country code using ISO 3166-1 alpha-3, e.g. FIN for Finland.

                                                                                                                                                                                                                                                                                                              • municipalitystringoptional

                                                                                                                                                                                                                                                                                                                Muncipality

                                                                                                                                                                                                                                                                                                              • statestringoptional

                                                                                                                                                                                                                                                                                                                State

                                                                                                                                                                                                                                                                                                            • contactobjectoptional

                                                                                                                                                                                                                                                                                                              The statement contact details

                                                                                                                                                                                                                                                                                                              Request body

                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                  "requestId": 999020220304124000,
                                                                                                                                                                                                                                                                                                                  "address": {
                                                                                                                                                                                                                                                                                                                      "address1": "Address line 1",
                                                                                                                                                                                                                                                                                                                      "address2": "Address line 2",
                                                                                                                                                                                                                                                                                                                      "address3": "Address line 3",
                                                                                                                                                                                                                                                                                                                      "address4": "Address line 4",
                                                                                                                                                                                                                                                                                                                      "postalCode": 328,
                                                                                                                                                                                                                                                                                                                      "city": "HEL",
                                                                                                                                                                                                                                                                                                                      "countryCode": "FIN",
                                                                                                                                                                                                                                                                                                                      "municipality": "Helsinki",
                                                                                                                                                                                                                                                                                                                      "state": "Uusimaa"
                                                                                                                                                                                                                                                                                                                  },
                                                                                                                                                                                                                                                                                                                  "contact": {
                                                                                                                                                                                                                                                                                                                      "email": "test-email@test-company.com"
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                              Responses

                                                                                                                                                                                                                                                                                                              • 201Createdoptional
                                                                                                                                                                                                                                                                                                                • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                  Response data of the processed request.

                                                                                                                                                                                                                                                                                                                  • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                    Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                  • messagestringoptional

                                                                                                                                                                                                                                                                                                                    The description of the status code.

                                                                                                                                                                                                                                                                                                                  • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                    Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                • systemAddressIdstringoptional

                                                                                                                                                                                                                                                                                                                  System generated unique identifier of the address.

                                                                                                                                                                                                                                                                                                              • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                  The response status of the processed request.

                                                                                                                                                                                                                                                                                                                  • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                    Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                  • messagestringoptional

                                                                                                                                                                                                                                                                                                                    Description of the response code

                                                                                                                                                                                                                                                                                                                  • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                    The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                  • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                    Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                              • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                  • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                    • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                      • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                        • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                          • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                            • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                              201

                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                  "responseStatus": {
                                                                                                                                                                                                                                                                                                                                      "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                      "message": "OK",
                                                                                                                                                                                                                                                                                                                                      "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                  },
                                                                                                                                                                                                                                                                                                                                  "systemAddressId": 3234330
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Update statement address of the customer.

                                                                                                                                                                                                                                                                                                                              PUT /institutions/{institutionId}/accounts/addresses/statement/{systemAddressId}

                                                                                                                                                                                                                                                                                                                              This operation updates the full statement address for a given account. The account contract number for address update will be provided as a header parameter.

                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                              • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                The identifier of the issuer in Nets AMS. The ID of the institution is given by Nets.

                                                                                                                                                                                                                                                                                                                              • systemAddressIdnumberrequired

                                                                                                                                                                                                                                                                                                                                Unique identifier of the address in Nets AMS.

                                                                                                                                                                                                                                                                                                                              • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                              • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                              • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                              Update statement address of the customer.

                                                                                                                                                                                                                                                                                                                              var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/addresses/statement/3235030");
                                                                                                                                                                                                                                                                                                                              var request = new RestRequest(Method.PUT);
                                                                                                                                                                                                                                                                                                                              request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                                              request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                              request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                              request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                              request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                                              IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                              Request body

                                                                                                                                                                                                                                                                                                                              • requestIdstringrequired

                                                                                                                                                                                                                                                                                                                                Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                                                                                                                • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                                                                                                                • Number must be unique within the institution.
                                                                                                                                                                                                                                                                                                                              • addressobjectoptional

                                                                                                                                                                                                                                                                                                                                The generic address fields

                                                                                                                                                                                                                                                                                                                                • address1stringrequired

                                                                                                                                                                                                                                                                                                                                  Address line 1.

                                                                                                                                                                                                                                                                                                                                • address2stringoptional

                                                                                                                                                                                                                                                                                                                                  Address line 2.

                                                                                                                                                                                                                                                                                                                                • address3stringoptional

                                                                                                                                                                                                                                                                                                                                  Address line 3.

                                                                                                                                                                                                                                                                                                                                • address4stringoptional

                                                                                                                                                                                                                                                                                                                                  Address line 4.

                                                                                                                                                                                                                                                                                                                                • postalCodestringoptional

                                                                                                                                                                                                                                                                                                                                  Postal code

                                                                                                                                                                                                                                                                                                                                • citystringrequired

                                                                                                                                                                                                                                                                                                                                  Name of the city

                                                                                                                                                                                                                                                                                                                                • countryCodestringrequired

                                                                                                                                                                                                                                                                                                                                  Country code using ISO 3166-1 alpha-3, e.g. FIN for Finland.

                                                                                                                                                                                                                                                                                                                                • municipalitystringoptional

                                                                                                                                                                                                                                                                                                                                  Muncipality

                                                                                                                                                                                                                                                                                                                                • statestringoptional

                                                                                                                                                                                                                                                                                                                                  State

                                                                                                                                                                                                                                                                                                                              • contactobjectoptional

                                                                                                                                                                                                                                                                                                                                The statement contact details

                                                                                                                                                                                                                                                                                                                                Request body

                                                                                                                                                                                                                                                                                                                                {
                                                                                                                                                                                                                                                                                                                                    "requestId": 999020220304124000,
                                                                                                                                                                                                                                                                                                                                    "address": {
                                                                                                                                                                                                                                                                                                                                        "address1": "Address line 1",
                                                                                                                                                                                                                                                                                                                                        "address2": "Address line 2",
                                                                                                                                                                                                                                                                                                                                        "address3": "Address line 3",
                                                                                                                                                                                                                                                                                                                                        "address4": "Address line 4",
                                                                                                                                                                                                                                                                                                                                        "postalCode": 328,
                                                                                                                                                                                                                                                                                                                                        "city": "HEL",
                                                                                                                                                                                                                                                                                                                                        "countryCode": "FIN",
                                                                                                                                                                                                                                                                                                                                        "municipality": "Helsinki",
                                                                                                                                                                                                                                                                                                                                        "state": "Uusimaa"
                                                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                                                    "contact": {
                                                                                                                                                                                                                                                                                                                                        "email": "test-email@test-company.com"
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Responses

                                                                                                                                                                                                                                                                                                                                • 200OKoptional
                                                                                                                                                                                                                                                                                                                                  • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                    Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                    • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                      Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                    • messagestringoptional

                                                                                                                                                                                                                                                                                                                                      The description of the status code.

                                                                                                                                                                                                                                                                                                                                    • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                      Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                  • systemAddressIdstringoptional

                                                                                                                                                                                                                                                                                                                                    System generated unique identifier of the address.

                                                                                                                                                                                                                                                                                                                                • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                  • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                    The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                    • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                      Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                    • messagestringoptional

                                                                                                                                                                                                                                                                                                                                      Description of the response code

                                                                                                                                                                                                                                                                                                                                    • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                      The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                    • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                      Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                  • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                    • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                      • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                        • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                          • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                            • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                              • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                200

                                                                                                                                                                                                                                                                                                                                                {
                                                                                                                                                                                                                                                                                                                                                    "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                        "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                        "message": "OK",
                                                                                                                                                                                                                                                                                                                                                        "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                    },
                                                                                                                                                                                                                                                                                                                                                    "systemAddressId": 3234330
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Retrieve list of account addresses.

                                                                                                                                                                                                                                                                                                                                                GET /institutions/{institutionId}/accounts/addresses

                                                                                                                                                                                                                                                                                                                                                This operation retrieves list of active and future addreses for the specific account. The accountContractNumber used during the account creation must be passed as a header parameter. List of addresses includes,

                                                                                                                                                                                                                                                                                                                                                • Statement address

                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                  Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                  A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                  Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                  Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                Retrieve list of account addresses.

                                                                                                                                                                                                                                                                                                                                                var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/addresses");
                                                                                                                                                                                                                                                                                                                                                var request = new RestRequest(Method.GET);
                                                                                                                                                                                                                                                                                                                                                request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                Responses

                                                                                                                                                                                                                                                                                                                                                • 200OKoptional
                                                                                                                                                                                                                                                                                                                                                  • addressesarrayrequired

                                                                                                                                                                                                                                                                                                                                                    The list of addresses will be returned if multiple address categories exist for the account.

                                                                                                                                                                                                                                                                                                                                                    • systemAddressIdstringoptional

                                                                                                                                                                                                                                                                                                                                                      System generated unique identifier of the address.

                                                                                                                                                                                                                                                                                                                                                    • addressCategorystringrequired

                                                                                                                                                                                                                                                                                                                                                      Address category defines the type of the address. Possible values:

                                                                                                                                                                                                                                                                                                                                                      • STATEMENT = Used for statement delivery address of the account.

                                                                                                                                                                                                                                                                                                                                                      STATEMENT

                                                                                                                                                                                                                                                                                                                                                    • addressobjectoptional

                                                                                                                                                                                                                                                                                                                                                      The generic address fields

                                                                                                                                                                                                                                                                                                                                                      • address1stringrequired

                                                                                                                                                                                                                                                                                                                                                        Address line 1.

                                                                                                                                                                                                                                                                                                                                                      • address2stringoptional

                                                                                                                                                                                                                                                                                                                                                        Address line 2.

                                                                                                                                                                                                                                                                                                                                                      • address3stringoptional

                                                                                                                                                                                                                                                                                                                                                        Address line 3.

                                                                                                                                                                                                                                                                                                                                                      • address4stringoptional

                                                                                                                                                                                                                                                                                                                                                        Address line 4.

                                                                                                                                                                                                                                                                                                                                                      • postalCodestringoptional

                                                                                                                                                                                                                                                                                                                                                        Postal code

                                                                                                                                                                                                                                                                                                                                                      • citystringrequired

                                                                                                                                                                                                                                                                                                                                                        Name of the city

                                                                                                                                                                                                                                                                                                                                                      • countryCodestringrequired

                                                                                                                                                                                                                                                                                                                                                        Country code using ISO 3166-1 alpha-3, e.g. FIN for Finland.

                                                                                                                                                                                                                                                                                                                                                      • municipalitystringoptional

                                                                                                                                                                                                                                                                                                                                                        Muncipality

                                                                                                                                                                                                                                                                                                                                                      • statestringoptional

                                                                                                                                                                                                                                                                                                                                                        State

                                                                                                                                                                                                                                                                                                                                                    • contactobjectoptional

                                                                                                                                                                                                                                                                                                                                                      The statement contact details

                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                      Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                      • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                        The description of the status code.

                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                  • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                      The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                      • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                        Description of the response code

                                                                                                                                                                                                                                                                                                                                                      • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                        The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                  • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                    • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                      • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                        • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                          • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                            • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                              • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                  200

                                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                                      "addresses": [
                                                                                                                                                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                                                                                                                                                              "systemAddressId": 3234330,
                                                                                                                                                                                                                                                                                                                                                                              "addressCategory": "STATEMENT",
                                                                                                                                                                                                                                                                                                                                                                              "address": {
                                                                                                                                                                                                                                                                                                                                                                                  "address1": "Address line 1",
                                                                                                                                                                                                                                                                                                                                                                                  "address2": "Address line 2",
                                                                                                                                                                                                                                                                                                                                                                                  "address3": "Address line 3",
                                                                                                                                                                                                                                                                                                                                                                                  "address4": "Address line 4",
                                                                                                                                                                                                                                                                                                                                                                                  "postalCode": 328,
                                                                                                                                                                                                                                                                                                                                                                                  "city": "HEL",
                                                                                                                                                                                                                                                                                                                                                                                  "countryCode": "FIN",
                                                                                                                                                                                                                                                                                                                                                                                  "municipality": "Helsinki",
                                                                                                                                                                                                                                                                                                                                                                                  "state": "Uusimaa"
                                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                                              "contact": {
                                                                                                                                                                                                                                                                                                                                                                                  "email": "test-email@test-company.com"
                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                      ],
                                                                                                                                                                                                                                                                                                                                                                      "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                                          "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                          "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                          "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Retrieve account parameters

                                                                                                                                                                                                                                                                                                                                                                  GET /institutions/{institutionId}/accounts/parameters

                                                                                                                                                                                                                                                                                                                                                                  This operation is used to retrieve accoun parameters by providing account contract number as header parameter.

                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                  • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                    Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                  • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                    A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                  • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                    Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                  • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                    Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                  Retrieve account parameters

                                                                                                                                                                                                                                                                                                                                                                  var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/parameters");
                                                                                                                                                                                                                                                                                                                                                                  var request = new RestRequest(Method.GET);
                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                  IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                  Responses

                                                                                                                                                                                                                                                                                                                                                                  • 200OKoptional
                                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                      Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                      • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                        The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                  • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                      The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                      • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                        Description of the response code

                                                                                                                                                                                                                                                                                                                                                                      • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                        The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                  • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                    • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                      • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                                        • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                                          • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                                            • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                                              • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                                • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                                  200

                                                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                                                      "parameters": {
                                                                                                                                                                                                                                                                                                                                                                                          "issuingProduct": "TEST_ISS_PROD",
                                                                                                                                                                                                                                                                                                                                                                                          "communicationChannel": "P",
                                                                                                                                                                                                                                                                                                                                                                                          "dueDate": "DD01",
                                                                                                                                                                                                                                                                                                                                                                                          "statementDeliveryType": "DP",
                                                                                                                                                                                                                                                                                                                                                                                          "directDebitStatus": "REG",
                                                                                                                                                                                                                                                                                                                                                                                          "minimumPayment": "P",
                                                                                                                                                                                                                                                                                                                                                                                          "firstPaymentFreeMonth": 1,
                                                                                                                                                                                                                                                                                                                                                                                          "secondPaymentFreeMonth": 1,
                                                                                                                                                                                                                                                                                                                                                                                          "institutionParameter": [
                                                                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                                                                  "code": "TEST_ISS_PROD",
                                                                                                                                                                                                                                                                                                                                                                                                  "value": "BANK_MC_PLATINUM"
                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                          ]
                                                                                                                                                                                                                                                                                                                                                                                      },
                                                                                                                                                                                                                                                                                                                                                                                      "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                                                          "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                                          "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                                          "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Update accounts parameters

                                                                                                                                                                                                                                                                                                                                                                                  PATCH /institutions/{institutionId}/accounts/parameters

                                                                                                                                                                                                                                                                                                                                                                                  This operation is used to update parameters for a given account. The accountContractNumber for which the parameters are to be updated will be provided as header parameters.

                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                  • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                    Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                                  • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                                    A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                                  • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                                    Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                                  • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                    Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                                  Update accounts parameters

                                                                                                                                                                                                                                                                                                                                                                                  var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/parameters");
                                                                                                                                                                                                                                                                                                                                                                                  var request = new RestRequest(Method.PATCH);
                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                  request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                                                                                                  IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                                  Request body

                                                                                                                                                                                                                                                                                                                                                                                  • requestIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                    Unique request identification from the issuer in the request.

                                                                                                                                                                                                                                                                                                                                                                                    • The request-id should start with a 4-digit institution ID unless agreed otherwise.
                                                                                                                                                                                                                                                                                                                                                                                    • Number must be unique within the institution.

                                                                                                                                                                                                                                                                                                                                                                                  Request body

                                                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                                                      "requestId": 999020220304124000,
                                                                                                                                                                                                                                                                                                                                                                                      "parameters": {
                                                                                                                                                                                                                                                                                                                                                                                          "issuingProduct": "TEST_ISS_PROD",
                                                                                                                                                                                                                                                                                                                                                                                          "communicationChannel": "P",
                                                                                                                                                                                                                                                                                                                                                                                          "dueDate": "DD01",
                                                                                                                                                                                                                                                                                                                                                                                          "statementDeliveryType": "DP",
                                                                                                                                                                                                                                                                                                                                                                                          "directDebitStatus": "REG",
                                                                                                                                                                                                                                                                                                                                                                                          "minimumPayment": "P",
                                                                                                                                                                                                                                                                                                                                                                                          "firstPaymentFreeMonth": 1,
                                                                                                                                                                                                                                                                                                                                                                                          "secondPaymentFreeMonth": 1,
                                                                                                                                                                                                                                                                                                                                                                                          "institutionParameter": [
                                                                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                                                                  "code": "TEST_ISS_PROD",
                                                                                                                                                                                                                                                                                                                                                                                                  "value": "BANK_MC_PLATINUM"
                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                          ]
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                  Responses

                                                                                                                                                                                                                                                                                                                                                                                  • 200OKoptional
                                                                                                                                                                                                                                                                                                                                                                                    • requestIdobjectoptional

                                                                                                                                                                                                                                                                                                                                                                                      Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                      • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                        The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                  • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                      The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                      • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                        Description of the response code

                                                                                                                                                                                                                                                                                                                                                                                      • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                        The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                  • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                                    • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                                      • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                                                        • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                                                          • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                                                            • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                                                              • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                                                • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                                                  200

                                                                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                                                                      "requestId": {
                                                                                                                                                                                                                                                                                                                                                                                                          "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                                                          "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                                                          "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                  Retrieve account limits

                                                                                                                                                                                                                                                                                                                                                                                                  GET /institutions/{institutionId}/accounts/limits

                                                                                                                                                                                                                                                                                                                                                                                                  This operation is used to retrieve list of account limit by providing account contract number as header parameter.

                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                    Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                                                  • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                                                    A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                                                  • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                    Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                  • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                    Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                                                  Retrieve account limits

                                                                                                                                                                                                                                                                                                                                                                                                  var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/accounts/limits");
                                                                                                                                                                                                                                                                                                                                                                                                  var request = new RestRequest(Method.GET);
                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                  IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                                                  Responses

                                                                                                                                                                                                                                                                                                                                                                                                  • 200OKoptional
                                                                                                                                                                                                                                                                                                                                                                                                    • limitsarrayoptional

                                                                                                                                                                                                                                                                                                                                                                                                      A list of all limits for an account is returned.

                                                                                                                                                                                                                                                                                                                                                                                                      • typestringrequired

                                                                                                                                                                                                                                                                                                                                                                                                        This is the type of limit. Possible values:

                                                                                                                                                                                                                                                                                                                                                                                                        • CRED_LIMIT= credit limit granted to account
                                                                                                                                                                                                                                                                                                                                                                                                        • INST_LIMIT = instalment limit for unsecured loan
                                                                                                                                                                                                                                                                                                                                                                                                        • TEMP_LIMIT = temporary limit
                                                                                                                                                                                                                                                                                                                                                                                                      • amountnumber (double)required

                                                                                                                                                                                                                                                                                                                                                                                                        The amount of the limit.

                                                                                                                                                                                                                                                                                                                                                                                                      • currencyintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                                        Three digits ISO-4217 currency code, E.g. "978" for Euro.

                                                                                                                                                                                                                                                                                                                                                                                                      • fromDatestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                        Limit activation date in YYYY-MM-DD format. Applicable only for limit type "TEMP_LIMIT".

                                                                                                                                                                                                                                                                                                                                                                                                      • toDatestring (date)optional

                                                                                                                                                                                                                                                                                                                                                                                                        Limit expiration date in YYYY-MM-DD format. Applicable only for limit type "TEMP_LIMIT".

                                                                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                                      Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                      • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                        The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                  • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                                                    • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                                      The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                      • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                                                        Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                      • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                        Description of the response code

                                                                                                                                                                                                                                                                                                                                                                                                      • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                        The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                                                      • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                        Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                  • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                                                    • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                                                      • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                                                                        • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                                                                          • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                                                                            • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                                                                              • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                                                                • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                                                                  200

                                                                                                                                                                                                                                                                                                                                                                                                                  {
                                                                                                                                                                                                                                                                                                                                                                                                                      "limits": [
                                                                                                                                                                                                                                                                                                                                                                                                                          {
                                                                                                                                                                                                                                                                                                                                                                                                                              "type": "CRED_LIMIT",
                                                                                                                                                                                                                                                                                                                                                                                                                              "amount": 648.55,
                                                                                                                                                                                                                                                                                                                                                                                                                              "currency": 986,
                                                                                                                                                                                                                                                                                                                                                                                                                              "fromDate": "2022-11-15",
                                                                                                                                                                                                                                                                                                                                                                                                                              "toDate": "2023-01-31"
                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                      ],
                                                                                                                                                                                                                                                                                                                                                                                                                      "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                                                                                          "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                                                                          "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                                                                          "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Creates a new credit card

                                                                                                                                                                                                                                                                                                                                                                                                                  POST /institutions/{institutionId}/cards/credit

                                                                                                                                                                                                                                                                                                                                                                                                                  Create a new credit card for a given account.

                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                  • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                    Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                                                                  • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                                                                    A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                                                                  • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                    Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                  • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                    Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                                                                  Creates a new credit card

                                                                                                                                                                                                                                                                                                                                                                                                                  var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/cards/credit");
                                                                                                                                                                                                                                                                                                                                                                                                                  var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                  request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                  request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                                                                                                                                  IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                                                                  Request body

                                                                                                                                                                                                                                                                                                                                                                                                                    Responses

                                                                                                                                                                                                                                                                                                                                                                                                                    • 201Createdoptional
                                                                                                                                                                                                                                                                                                                                                                                                                      • maskedCardNumberstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                        Masked card number in NNNNNNXXXXXXNNNN format. Depending on the institution's setup, either a card number or a masked card number is provided.

                                                                                                                                                                                                                                                                                                                                                                                                                      • cardIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                        Unique id of the card.

                                                                                                                                                                                                                                                                                                                                                                                                                      • expiryDatestring (date)optional

                                                                                                                                                                                                                                                                                                                                                                                                                        Card expiry date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                                                                                                                                                      • panSequenceNumberintegeroptional

                                                                                                                                                                                                                                                                                                                                                                                                                        Sequence number of the plastic.

                                                                                                                                                                                                                                                                                                                                                                                                                      • systemCardIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                        System generated unique card identifier .

                                                                                                                                                                                                                                                                                                                                                                                                                      • responseStatusobjectoptional

                                                                                                                                                                                                                                                                                                                                                                                                                        Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                        • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                                                          Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                        • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                          The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                    • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                                                                      • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                                                        The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                        • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                                                                          Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                        • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                          Description of the response code

                                                                                                                                                                                                                                                                                                                                                                                                                        • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                          The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                                                                        • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                          Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                    • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                                                                      • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                                                                        • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                                                                                          • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                                                                                            • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                                                                                              • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                  • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                    201

                                                                                                                                                                                                                                                                                                                                                                                                                                    {
                                                                                                                                                                                                                                                                                                                                                                                                                                        "maskedCardNumber": "499990XXXXXX8984",
                                                                                                                                                                                                                                                                                                                                                                                                                                        "cardId": 999011189837890,
                                                                                                                                                                                                                                                                                                                                                                                                                                        "expiryDate": "2019-01-02",
                                                                                                                                                                                                                                                                                                                                                                                                                                        "panSequenceNumber": 10,
                                                                                                                                                                                                                                                                                                                                                                                                                                        "systemCardId": 1234567890123456,
                                                                                                                                                                                                                                                                                                                                                                                                                                        "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                                                                                                            "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                                                                                            "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                                                                                            "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                    Creates a new supplementary credit card

                                                                                                                                                                                                                                                                                                                                                                                                                                    POST /institutions/{institutionId}/cards/credit/supplementary

                                                                                                                                                                                                                                                                                                                                                                                                                                    Create a new upplementary credit card for a given customer.

                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                    • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                      Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                                                                                      A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                      Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • uniqueRegNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                      Unique customer Identification of a customer. Use the same uniqueRegNumber received during the customer creation.

                                                                                                                                                                                                                                                                                                                                                                                                                                    • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                      Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                                                                                    Creates a new supplementary credit card

                                                                                                                                                                                                                                                                                                                                                                                                                                    var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/cards/credit/supplementary");
                                                                                                                                                                                                                                                                                                                                                                                                                                    var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddHeader("uniqueRegNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                    request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                                                                                                                                                    IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                                                                                    Request body

                                                                                                                                                                                                                                                                                                                                                                                                                                      Responses

                                                                                                                                                                                                                                                                                                                                                                                                                                      • 201Createdoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                        • maskedCardNumberstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                          Masked card number in NNNNNNXXXXXXNNNN format. Depending on the institution's setup, either a card number or a masked card number is provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                        • cardIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                          Unique id of the card.

                                                                                                                                                                                                                                                                                                                                                                                                                                        • expiryDatestring (date)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                          Card expiry date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                                                                                                                                                                        • panSequenceNumberintegeroptional

                                                                                                                                                                                                                                                                                                                                                                                                                                          Sequence number of the plastic.

                                                                                                                                                                                                                                                                                                                                                                                                                                        • systemCardIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                          System generated unique card identifier .

                                                                                                                                                                                                                                                                                                                                                                                                                                        • responseStatusobjectoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                          Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                            The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                                      • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                        • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                          The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                                                                                            Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                            Description of the response code

                                                                                                                                                                                                                                                                                                                                                                                                                                          • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                            The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                                                                                          • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                            Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                                      • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                                                                                        • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                                                                                          • 404Not foundoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                            • 408Request Timeoutoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                              • 500Internal Server Erroroptional
                                                                                                                                                                                                                                                                                                                                                                                                                                                • 502Bad Gatewayoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 503Service Unavailableoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 504Gateway Timeoutoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                      201

                                                                                                                                                                                                                                                                                                                                                                                                                                                      {
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "maskedCardNumber": "499990XXXXXX8984",
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "cardId": 999011189837890,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "expiryDate": "2019-01-02",
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "panSequenceNumber": 10,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "systemCardId": 1234567890123456,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          "responseStatus": {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              "responseCode": 0,
                                                                                                                                                                                                                                                                                                                                                                                                                                                              "message": "OK",
                                                                                                                                                                                                                                                                                                                                                                                                                                                              "serverTime": "2019-01-02T12:00:45.201Z"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Creates a new debit card

                                                                                                                                                                                                                                                                                                                                                                                                                                                      POST /institutions/{institutionId}/cards/debit

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Create a new credit card for a given account.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • institutionIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Identification of the issuer in Nets AMS, Institution ID is assigned by Nets.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • X-Request-IDstring (uuid)required

                                                                                                                                                                                                                                                                                                                                                                                                                                                        A universally unique identifier (UUID) for the request message, used for logging purposes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Authorizationstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authorization token in the format: Bearer + {space} + {accessToken}. Valid token must be fetched from the authorisation endpoint.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • accountContractNumberstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Account contract number of the account. Use the same account contract number you received when creating the account.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Creates a new debit card

                                                                                                                                                                                                                                                                                                                                                                                                                                                      var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/cards/debit");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      var request = new RestRequest(Method.POST);
                                                                                                                                                                                                                                                                                                                                                                                                                                                      request.AddHeader("content-type", "application/json");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      request.AddHeader("X-Request-ID", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      request.AddHeader("Authorization", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      request.AddHeader("accountContractNumber", "SOME_STRING_VALUE");
                                                                                                                                                                                                                                                                                                                                                                                                                                                      request.AddParameter("application/json", "{\"REPLACE_REQUEST_BODY\":\"REPLACE_REQUEST_BODY\"}", ParameterType.RequestBody);
                                                                                                                                                                                                                                                                                                                                                                                                                                                      IRestResponse response = client.Execute(request);

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Request body

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Responses

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 201Createdoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • maskedCardNumberstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Masked card number in NNNNNNXXXXXXNNNN format. Depending on the institution's setup, either a card number or a masked card number is provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • cardIdstringrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Unique id of the card.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • expiryDatestring (date)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Card expiry date in YYYY-MM-DD format.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • panSequenceNumberintegeroptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Sequence number of the plastic.

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • systemCardIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                            System generated unique card identifier .

                                                                                                                                                                                                                                                                                                                                                                                                                                                          • responseStatusobjectoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Response data of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • responseCodeintegerrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                              The description of the status code.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 400Bad requestoptional
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • responseStatusobjectrequired

                                                                                                                                                                                                                                                                                                                                                                                                                                                            The response status of the processed request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • responseCodeinteger (int64)required

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Status code of the processed operation request.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • messagestringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Description of the response code

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • errorIdstringoptional

                                                                                                                                                                                                                                                                                                                                                                                                                                                              The system generated a unique identifier that can be used to identify relevant records in server-side logs and databases uniquely.

                                                                                                                                                                                                                                                                                                                                                                                                                                                            • serverTimestring (date:time)optional

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Server-generated timestamp at the time of the event. Used to identify relevant log or database records in systems.

                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 401Unauthorized optional
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 403Forbidden optional
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 404Not foundoptional