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

Entity	Description
Customer	The 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)
Account	An 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.
Card	A 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.
Address	Address 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.
Transactions	Issuer information about account and card transactions and also authorisations for cards.
Fees	Add, update or fetch fees
Payments	Add, update or fetch payments

Supported products

Entity	Description
Credit Cards	To be written
Debit Cards	To be written
Combo Card	To be written.
Virtual Cards	To be written
Prepaid Cards	To be written
Loans	To be written

ISO Language Codes

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

Language code	Language Name
DAN	Danish
ENG	English
FIN	Finnish
GER	German
NOR	Norwegian
SWE	Swedish

ISO Country Codes

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

Country code	Country Name
ABW	Aruba
AFG	Afghanistan
AGO	Angola
AIA	Anguilla
ALA	Aland Islands
ALB	Albania
AND	Andorra
ANT	Netherlands Antilles
ARE	United Arab Emirates
ARG	Argentina
ARM	Armenia
ASM	American Samoa
ATA	Antarctica
ATF	French Southern Territories
ATG	Antigua And Barbuda
AUS	Australia
AUT	Austria
AZE	Azerbaijan
BDI	Burundi
BEL	Belgium
BEN	Benin
BES	Bonaire, Saint Eustatius and Saba
BFA	Burkina Faso
BGD	Bangladesh
BGR	Bulgaria
BHR	Bahrain
BHS	Bahamas
BIH	Bosnia Herzegovina
BLR	Belarus
BLZ	Belize
BMU	Bermuda
BOL	Bolivia
BRA	Brazil
BRB	Barbados
BRN	Brunei Darussalam
BTN	Bhutan
BVT	Bouvet Island
BWA	Botswana
CAF	Central African Republic
CAN	Canada
CCK	Cocos (Keeling) Islands
CDR	Congo, The Democratic Republic of
CHE	Switzerland
CHL	Chile
CHN	China
CIV	Cote D'Ivoire (Ivory Coast)
CMR	Cameroon,United Repuplic
COG	Congo, Republic of the
COK	Cook Islands
COL	Colombia
COM	Comoros
CPV	Cape Verde
CRI	Costa Rica
CUB	Cuba
CUW	Curacao
CXR	Christmas Island
CYM	Cayman Islands
CYP	Cyprus
CZE	Czech Republic
DEU	Germany
DJI	Djibouti
DMA	Dominica
DNK	Denmark
DOM	Dominican Republic
DZA	Algeria
ECU	Ecuador
EGY	Egypt
ERI	Eritrea
ESH	Western Sahara
ESP	Spain
EST	Estonia
ETH	Ethiopia
FIN	Finland
FJI	Fiji
FLK	Falkland Islands(Malvinas)
FRA	France
FRO	Faroe Islands
FSM	Micronesia, Federated States of
GAB	Gabon
GBR	United Kingdom
GEO	Georgia
GGY	Guernsey
GHA	Ghana
GIB	Gibraltar
GIN	Guinea
GLP	Guadeloupe
GMB	Gambia
GNB	Guinea-Bissau
GNQ	Equatorial Guinea
GRC	Greece
GRD	Grenada
GRL	Greenland
GTM	Guatemala
GUF	French Guiana
GUM	Guam
GUY	Guyana
HKG	Hong Kong
HMD	Heard and McDonald Islands
HND	Honduras
HRV	Croatia
HTI	Haiti
HUN	Hungary
IDN	Indonesia
IMN	Isle of Man
IND	India
IOT	British Indian Ocean Territory
IRL	Ireland
IRN	Iran, Islamic Republic of
IRQ	Iraq
ISL	Iceland
ISR	Israel
ITA	Italy
JAM	Jamaica
JEY	Jersey
JOR	Jordan
JPN	Japan
KAZ	Kazakhstan
KEN	Kenya
KGZ	Kyrgyzstan
KHM	Cambodia
KIR	Kiribati
KNA	St. Kitts-Nevis
KOR	Korea, Republic Of
KWT	Kuwait
LAO	Lao People's Democratic Republic
LBN	Lebanon
LBR	Liberia
LBY	Libyan Arab Jamahiriya
LCA	St. Lucia
LIE	Liechtenstein
LKA	Sri Lanka
LSO	Lesotho
LTU	Lithuania
LUX	Luxembourg
LVA	Latvia
MAC	Macao
MAR	Morocco
MCO	Monaco
MDA	Moldova, Republic Of
MDV	Maldives
MEX	Mexico
MGA	Madagascar
MHL	Marshall Islands
MKD	Macedonia
MLI	Mali
MLT	Malta
MMR	Myanmar
MNE	Montenegro
MNG	Mongolia
MNP	Northern Mariana Islands
MOZ	Mozambique
MRT	Mauritania
MSR	Montserrat
MTQ	Martinique
MUS	Mauritius
MWI	Malawi
MYS	Malaysia
MYT	Mayotte
NAM	Namibia
NCL	New Caledonia
NER	Niger
NFK	Norfolk Island
NGA	Nigeria
NIC	Nicaragua
NIU	Niue
NLD	Netherlands
NOR	Norway
NPL	Nepal
NRU	Nauru
NZL	New Zealand
OMN	Oman
PAK	Pakistan
PAN	Panama
PCN	Pitcairn Island
PER	Peru
PHL	Philippines
PLW	Palau
PNG	Independent State of Papua New Guinea
POL	Poland
PRI	Puerto Rico
PRK	Korea, Democratic People's Republic of
PRT	Portugal
PRY	Paraguay
PSE	Palestinian Territory, Occupied
PYF	French Polynesia
QAT	Qatar
QZZ	UNMIK
REU	Reunion
ROU	Romania
RUS	Russia
RWA	Rwanda
SAU	Saudi Arabia
SDN	Sudan
SEN	Senegal
SGP	Singapore
SGS	South Georgia and the South Sandwich Islands
SHN	Saint Helena, Ascension and Tristan Da Cunha
SJM	Svalbard and Jan Mayen Islands
SLB	Solomon Islands
SLE	Sierra Leone
SLV	El Salvador
SMR	San Marino
SOM	Somalia, Federal Republic of
SPM	St. Pierre and Miquelon
SRB	Serbia
SSD	South Sudan
STP	Sao Tome And Principe
SUR	Suriname
SVK	Slovakia
SVN	Slovenia
SWE	Sweden
SWZ	Swaziland
SXM	Sint Maarten (Dutch part)
SYC	Seychelles
SYR	Syrian Arab Republic
TCA	Turks and Caicos Islands
TCD	Chad
TGO	Togo
THA	Thailand
TJK	Tajikistan
TKL	Tokelau
TKM	Turkmenistan
TLS	Timor-Leste (East Timor)
TON	Tonga
TTO	Trinidad And Tobago
TUN	Tunisia
TUR	Turkey
TUV	Tuvalu
TWN	Taiwan Province Of China
TZA	Tanzania, United Republic of
UGA	Uganda
UKR	Ukraine
UMI	U.S. Minor Outlying Islands
URY	Uruguay
USA	United States
UZB	Uzbekistan
VAT	Vatican City State
VCT	St. Vincent and the Grenadines
VEN	Venezuela
VGB	Virgin Islands, British
VIR	Virgin Islands, U.S.
VNM	Vietnam
VUT	Vanuatu
WLF	Wallis and Futuna Islands
WSM	Samoa
YEM	Yemen
ZAF	South Africa
ZMB	Zambia
ZWE	Zimbabwe
BLM	Saint Barthelemy
COD	Congo, The Democratic Republic of Congo
FXX	France, Metropolitan
MAF	Saint Martin (French part)
MDG	MADAGASCAR
ROM	ROMANIA
TMP	TIMOR-LESTE
YYY	SUDAN - 2
ZAR	CONGO, DEMOCRATIC REPUBLIC OF

ISO Currency Codes

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

Character Set

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

Upper-case characters	Lower-case characters	Upper-case special characters	Lower-case special characters	Numbers
A	a	Á	á	0
B	b	À	à	1
C	c	Â	â	2
D	d	Ã	ã	3
E	e	Ç	ç	4
F	f	Ð	ð	5
G	g	É	é	6
H	h	È	è	7
I	i	Ê	ê	8
J	j	Ë	ë	9
K	k	Í	í
L	l	Ì	ì
M	m	Î	î
N	n	Ï	ï
O	o	Ñ	ñ
P	p	Ó	ó
Q	q	Ò	ò
R	r	Ô	ô
S	s	Õ	õ
T	t	ß	Þ
U	u	Ú	þ
V	v	Ù	ú
W	w	Û	ù
X	x	Ü	û
Y	y	Å	ý
Z	z	Ä	ü
	Æ	å
	Ö	ä
	Ø	æ
		ö
		ø

Changelog

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

C#PHPNodeShell

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

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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
}

Update legal address of the customer.

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.

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 legal address of the customer.

C#
PHP
Node
Shell

var client = new RestClient("https://api-gateway.nets.eu/account-service/v1/institutions/9990/customers/addresses/legal/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": {
        "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

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
}

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.

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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.

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

C#
PHP
Node
Shell

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

Upper-case characters	Lower-case characters	Upper-case special characters	Lower-case special characters	Numbers
A	a	Á	á	0
B	b	À	à	1
C	c	Â	â	2
D	d	Ã	ã	3
E	e	Ç	ç	4
F	f	Ð	ð	5
G	g	É	é	6
H	h	È	è	7
I	i	Ê	ê	8
J	j	Ë	ë	9
K	k	Í	í
L	l	Ì	ì
M	m	Î	î
N	n	Ï	ï
O	o	Ñ	ñ
P	p	Ó	ó
Q	q	Ò	ò
R	r	Ô	ô
S	s	Õ	õ
T	t	ß	Þ
U	u	Ú	þ
V	v	Ù	ú
W	w	Û	ù
X	x	Ü	û
Y	y	Å	ý
Z	z	Ä	ü
	Æ	å
	Ö	ä
	Ø	æ
		ö
		ø

Upper-case characters	Lower-case characters	Upper-case special characters	Lower-case special characters	Numbers
A	a	Á	á	0
B	b	À	à	1
C	c	Â	â	2
D	d	Ã	ã	3
E	e	Ç	ç	4
F	f	Ð	ð	5
G	g	É	é	6
H	h	È	è	7
I	i	Ê	ê	8
J	j	Ë	ë	9
K	k	Í	í
L	l	Ì	ì
M	m	Î	î
N	n	Ï	ï
O	o	Ñ	ñ
P	p	Ó	ó
Q	q	Ò	ò
R	r	Ô	ô
S	s	Õ	õ
T	t	ß	Þ
U	u	Ú	þ
V	v	Ù	ú
W	w	Û	ù
X	x	Ü	û
Y	y	Å	ý
Z	z	Ä	ü
	Æ	å
	Ö	ä
	Ø	æ
		ö
		ø

Upper-case characters	Lower-case characters	Upper-case special characters	Lower-case special characters	Numbers
A	a	Á	á	0
B	b	À	à	1
C	c	Â	â	2
D	d	Ã	ã	3
E	e	Ç	ç	4
F	f	Ð	ð	5
G	g	É	é	6
H	h	È	è	7
I	i	Ê	ê	8
J	j	Ë	ë	9
K	k	Í	í
L	l	Ì	ì
M	m	Î	î
N	n	Ï	ï
O	o	Ñ	ñ
P	p	Ó	ó
Q	q	Ò	ò
R	r	Ô	ô
S	s	Õ	õ
T	t	ß	Þ
U	u	Ú	þ
V	v	Ù	ú
W	w	Û	ù
X	x	Ü	û
Y	y	Å	ý
Z	z	Ä	ü
	Æ	å
	Ö	ä
	Ø	æ
		ö
		ø