Create Account

Last changes: 07-03-2023

Before creating a new account for an end user, check whether an account already exists by attempting to retrieve account information.

It is not required that the API method 1.5 Get Account Information is used to check whether an account already exists, if for example you track within your solution whether an end user already has an account.

In the next step, you call the API method 1.1 Create Account, where you can specify a variety of customer information.

In line with Strong Customer Authentication (SCA), any customer information, such as names and addresses, must be accurately provided and reflect real customer data, especially in the following:

firstName
lastName
addr1
houseNumber (if not included in "addr1")
city
postcode
countryCode
emailAddress

Please discuss with you business contacts when providing accurate data may not be possible in production, as it may result in transactions being rejected and future incompatibility.

If the value of "countryCode" is "US" (United States of America) or "CA" (Canada) the "state" parameter is required. The value of "state" must be a valid State Code. (ex. "countryCode": "US", "state": "NY",)

When creating a new account, it is necessary to specify an email-address, since it acts as an account identifier. Optionally, you can provide an external account reference matching an account number within your own system.

The example below creates an Account for the end user with the External Account Reference KDNR0001.

Create Account Request

Path:: PUT {baseURL}/account
Header:: Content-Type: application/json
Accept-Language: en-US
X-Auth-Token: eyJhbGciOiJSUzI1NiI{abbreviated}RW5kVG9rZW4=

{
    "partnerReference": "DEV-SVR001-DE_CUSTID-BJ93W32QB4_CARTID-B7GVYP74KD_WHDYKMHYQC",
    "externalAccountReference": "KDNR0001",
    "programCode": "COMPANYDE",
    "currCode": "EUR",
    "validFrom": "2018-10-20",
    "lastName": "Smith",
    "firstName": "Jacob",
    "addr1":"Anystreet 321",
    "city":"Anycity",
    "countryCode":"DE",
    "postCode":"12345",
    "dob": "1990-01-01",
    "emailAddress": "user@example.com",
    "useDifferentCorrespondenceAddress": false,
    "nationality": "DE",
    "localDate": "2018-10-20",
    "localTime": "111446",
    "custom1": "WVWZZZ3BZWE689725"
}

Create Account Response

Status Code:: 200 (OK)
Header:: Content-Type: application/json
Accept-Language: en-US

{
    "productCode": "EWLTDBT",
    "accTypeCode": "TECHNICAL",
    "custCode": "78034",
    "externalAccountReference": "KDNR0001",
    "accno": "1777888148",
    "statusCode": "ACTIVE",
    "validFrom": "2018-10-20",
    "validUntil": "2999-12-31",
    "accFlowStatusCode": "POPENDING",
    "programCode": "COMPANYDE",
    "partnerReference": "DEV-SVR001-DE_CUSTID-BJ93W32QB4_CARTID-B7GVYP74KD_WHDYKMHYQC",
    "localDate": "2018-10-20",
    "localTime": "111446",
    "sysDate": "2018-10-20",
    "sysTime": "101446",
    "responseCode": "0000",
    "responseDescription": "Successful execution",
    "additionalInformation": {
        "requestId": "aff2728481a181dc36daedc14055b516"
    }
}

We recommend the persistence of the internal account number, which is included in the response under the return parameter "accno".

Most API methods allow you to set the internal account number or the external account reference for the parameter "accno" (also see Account Number Type).

Previous

Next