Get accounts lower in the hierarchy

GET

subAccount

{accountId}

curl --request GET \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}' \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}', 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/subAccount/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "CREDIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "CREDIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "iban": {
    "iban": "FI7165429021331431"
  },
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "DEBIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "DEBIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "PREPAID_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "PREPAID_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "FLEET_SEK_SE",
  "status": "ACCOUNT_BLOCKED",
  "template": "FLEET_SEK_SE"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "MULTICURR_EUR",
  "status": "ACCOUNT_BLOCKED",
  "template": "MULTICURR_EUR"
}

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "CREDIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "CREDIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "iban": {
    "iban": "FI7165429021331431"
  },
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "DEBIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "DEBIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "PREPAID_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "PREPAID_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "FLEET_SEK_SE",
  "status": "ACCOUNT_BLOCKED",
  "template": "FLEET_SEK_SE"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "MULTICURR_EUR",
  "status": "ACCOUNT_BLOCKED",
  "template": "MULTICURR_EUR"
}

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

accountId

string<biginteger>

required

The account id to fetch list of accounts for

Query Parameters

auditUser

string

required

The audit user to log the request

page

integer

default:0

Current page

size

integer

default:30

How many accounts should be returned per page, default is 30. Cannot be more than 100.

Required range: 1 < x < 100

Response

Successful lookup of accounts

listCreditAccountResponse
listDebitAccountResponse
listPrepaidAccountResponse
listFleetAccountResponse
listMultiCurrAccountResponse

Account summary in a list. The returned properties depend on the account template.

available

number

Accounts's available amount

Example:

1000

balance

number

Account's balance

Example:

1000

currency

string

A valid ISO 4217 currency code

Pattern: [A-Z]{3}

Example:

"EUR"

customerId

string

Customer id for account owner

Example:

55667788990

string

Unique account id for given account

Example:

1234567890

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

parentId

string

Account id of parent account. If empty then this is parent contract.

Example:

9876543210

status

enum<string>

Available options:

ACCOUNT_BLOCKED,

ACCOUNT_COLLECTION,

ACCOUNT_OK,

ACCOUNT_TO_CLOSE,

ACCOUNT_CLOSED,

ACCOUNT_AUTO_CLOSED

paymentReference

object

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

Show child attributes

productCode

string

The productCode is used to determine the specific account product. Values of the field are dependent on institution setup.

Example:

"DEBIT_EUR_FI"

template

string

Template name for which the account is connected to

creditLimit

number

Credit limit of the account

Example:

10000

⌘I

Get accounts lower in the hierarchy

curl --request GET \
  --globoff \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}' \
  --header 'Authorization: Basic <encoded-value>'

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}', 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/subAccount/{accountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/subAccount/{accountId}")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "CREDIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "CREDIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "iban": {
    "iban": "FI7165429021331431"
  },
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "DEBIT_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "DEBIT_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "PREPAID_EUR_FI",
  "status": "ACCOUNT_BLOCKED",
  "template": "PREPAID_EUR_FI"
}

{
  "available": 1000,
  "balance": 1000,
  "creditLimit": 10000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "FLEET_SEK_SE",
  "status": "ACCOUNT_BLOCKED",
  "template": "FLEET_SEK_SE"
}

{
  "available": 1000,
  "balance": 1000,
  "currency": "EUR",
  "customerId": 55667788990,
  "id": 1234567890,
  "name": "My example account name",
  "number": 123456789,
  "parentId": 9876543210,
  "paymentReference": {
    "number": 1234567897,
    "type": "MOD10"
  },
  "productCode": "MULTICURR_EUR",
  "status": "ACCOUNT_BLOCKED",
  "template": "MULTICURR_EUR"
}

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

Get accounts lower in the hierarchy

Authorizations

Path Parameters

Query Parameters

Response