Create credit account

POST

CREDIT

customer

{customerId}

Create credit account

curl --request POST \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditLimit": 10000,
  "additionalValues": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentTerms": 10,
  "eInvoice": {
    "address": "FI7165429021331431",
    "operator": "NDEAFIHH",
    "paymentInstruction": "AA"
  },
  "invoiceDayOfMonth": 21,
  "minimumToPay": {
    "amount": 123,
    "percentage": 50
  },
  "productCode": "CREDIT_EUR_FI"
}
'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}"

payload = {
    "creditLimit": 10000,
    "additionalValues": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "name": "My example account name",
    "number": 123456789,
    "parentId": 9876543210,
    "paymentTerms": 10,
    "eInvoice": {
        "address": "FI7165429021331431",
        "operator": "NDEAFIHH",
        "paymentInstruction": "AA"
    },
    "invoiceDayOfMonth": 21,
    "minimumToPay": {
        "amount": 123,
        "percentage": 50
    },
    "productCode": "CREDIT_EUR_FI"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    creditLimit: 10000,
    additionalValues: [{key: '<string>', value: '<string>'}],
    name: 'My example account name',
    number: 123456789,
    parentId: 9876543210,
    paymentTerms: 10,
    eInvoice: {address: 'FI7165429021331431', operator: 'NDEAFIHH', paymentInstruction: 'AA'},
    invoiceDayOfMonth: 21,
    minimumToPay: {amount: 123, percentage: 50},
    productCode: 'CREDIT_EUR_FI'
  })
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'creditLimit' => 10000,
    'additionalValues' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'name' => 'My example account name',
    'number' => 123456789,
    'parentId' => 9876543210,
    'paymentTerms' => 10,
    'eInvoice' => [
        'address' => 'FI7165429021331431',
        'operator' => 'NDEAFIHH',
        'paymentInstruction' => 'AA'
    ],
    'invoiceDayOfMonth' => 21,
    'minimumToPay' => [
        'amount' => 123,
        'percentage' => 50
    ],
    'productCode' => 'CREDIT_EUR_FI'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}"

	payload := strings.NewReader("{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

customerId

string<biginteger>

required

The customer id of which customer you want to create the account on

Query Parameters

auditUser

string

required

The audit user to log the request

Body

application/json

The fields that you want to apply to your newly created account, these values will override the predefined template values

creditLimit

number

required

Credit limit of the account

Example:

10000

address

address · object

Address connected to an account that will override the address set on customer level. This is for example used when sending out statements

Show child attributes

additionalValues

object[]

List of additional key-value pairs that can be associated with the account. Known keys:

BALC: Balance check configuration. Possible values: true (Shadow Balancing Disabled) or false (Shadow Balancing Enabled)

Maximum array length: 4

Show child attributes

name

string

Human readable name of an account

Maximum string length: 64

Example:

"My example account name"

number

string

Unique account number for given account. Must be numeric if paymentRefence.type defined as MOD10 or FINNISH_7_3_1! Note that selected account numbers might be reserved by Enfuce for internal usage.

Maximum string length: 64

Example:

123456789

segment

enum<string>

Field enables to group an entity into a segment. This field will be exported but no logic is applied to this in Enfuce API

Available options:

SEGMENT_A,

SEGMENT_B,

SEGMENT_C,

SEGMENT_D,

SEGMENT_E,

SEGMENT_F

paymentReference

object

Number connected to account that will be used to map incoming payments to

Show child attributes

parentId

string<biginteger>

This field is used when the institution is setting up an account liability hierarchy. The parentId is used to determine the parent of this account. Consult Enfuce before using this field.

Example:

9876543210

paymentTerms

integer

Number of days to allow for invoice to be paid before it goes overdue.

Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce before taking into use.

Required range: 1 <= x <= 30

Example:

10

eInvoice

object

deprecated

Show child attributes

invoiceDayOfMonth

integer

This indicates the last day of the billing period. An invoice is created and sent on the next day. If the scheduled day exceeds the total number of days in a month, then the invoice is generated on last day of the month.

Required range: 1 <= x <= 31

Example:

21

invoiceDeliveryMethod

enum<string>

Available options:

REGULAR_MAIL,

EMAIL,

E_INVOICE,

CUSTOM_1,

CUSTOM_2,

CUSTOM_3,

CUSTOM_4,

CUSTOM_5,

BETALINGSSERVICE

minimumToPay

object

Show child attributes

productCode

string

This field is used when the institution has multiple account products setup. The productCode is used to determine the specific account product. Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce prior to use.

Pattern: ^[A-Z][A-Z_0-9]{1,64}$

Example:

"CREDIT_EUR_FI"

invoicePaymentMethod

enum<string>

Use of this field as well as the values of the field, is dependent on institution setup and should be aligned with Enfuce prior to use. Also, it is only a value, there is no functionality behind it.

Available options:

DIRECT_DEBIT,

PLUS_GIROT,

BANK_GIROT,

BANK_TRANSFER,

IBAN

Response

Successful creation of the account

description

string

When a payment is declined, a response description is returned, if available, providing more context on why the transaction failed. This includes a return code and a brief explanation. If multiple issues cause the decline, only one response description is sent; the most recent reason for decline is returned. If the payment is successful, the resourceResponse attribute is returned with null value.

Example:

"061-Usage Limit '24H_RETAIL' Amount Exceeded"

string

Will contain the ID of the resource that has been created or updated

⌘I

Create credit account

curl --request POST \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "creditLimit": 10000,
  "additionalValues": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentTerms": 10,
  "eInvoice": {
    "address": "FI7165429021331431",
    "operator": "NDEAFIHH",
    "paymentInstruction": "AA"
  },
  "invoiceDayOfMonth": 21,
  "minimumToPay": {
    "amount": 123,
    "percentage": 50
  },
  "productCode": "CREDIT_EUR_FI"
}
'

import requests

url = "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}"

payload = {
    "creditLimit": 10000,
    "additionalValues": [
        {
            "key": "<string>",
            "value": "<string>"
        }
    ],
    "name": "My example account name",
    "number": 123456789,
    "parentId": 9876543210,
    "paymentTerms": 10,
    "eInvoice": {
        "address": "FI7165429021331431",
        "operator": "NDEAFIHH",
        "paymentInstruction": "AA"
    },
    "invoiceDayOfMonth": 21,
    "minimumToPay": {
        "amount": 123,
        "percentage": 50
    },
    "productCode": "CREDIT_EUR_FI"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    creditLimit: 10000,
    additionalValues: [{key: '<string>', value: '<string>'}],
    name: 'My example account name',
    number: 123456789,
    parentId: 9876543210,
    paymentTerms: 10,
    eInvoice: {address: 'FI7165429021331431', operator: 'NDEAFIHH', paymentInstruction: 'AA'},
    invoiceDayOfMonth: 21,
    minimumToPay: {amount: 123, percentage: 50},
    productCode: 'CREDIT_EUR_FI'
  })
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'creditLimit' => 10000,
    'additionalValues' => [
        [
                'key' => '<string>',
                'value' => '<string>'
        ]
    ],
    'name' => 'My example account name',
    'number' => 123456789,
    'parentId' => 9876543210,
    'paymentTerms' => 10,
    'eInvoice' => [
        'address' => 'FI7165429021331431',
        'operator' => 'NDEAFIHH',
        'paymentInstruction' => 'AA'
    ],
    'invoiceDayOfMonth' => 21,
    'minimumToPay' => [
        'amount' => 123,
        'percentage' => 50
    ],
    'productCode' => 'CREDIT_EUR_FI'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}"

	payload := strings.NewReader("{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/CREDIT/customer/{customerId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"creditLimit\": 10000,\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"parentId\": 9876543210,\n  \"paymentTerms\": 10,\n  \"eInvoice\": {\n    \"address\": \"FI7165429021331431\",\n    \"operator\": \"NDEAFIHH\",\n    \"paymentInstruction\": \"AA\"\n  },\n  \"invoiceDayOfMonth\": 21,\n  \"minimumToPay\": {\n    \"amount\": 123,\n    \"percentage\": 50\n  },\n  \"productCode\": \"CREDIT_EUR_FI\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "061-Usage Limit '24H_RETAIL' Amount Exceeded",
  "id": "<string>"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

Introduction

Account Details

Authorisation Control

Authorisation Forwarding

Card details

Customer

Exchange Rates API

ID

Instalment

Invoice

Notification

PIN

PIN Control

Purchase Details

Repricing

Transaction

Transfer API

Wallet

Test API

Hierarchy API

Spend Control API

Fraud Case API

Create credit account

Authorizations

Path Parameters

Query Parameters

Body

Response