Create account

POST

customer

{customerId}

Create account

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/customer/{customerId}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountTemplate": "PREPAID",
  "creditLimit": 10000,
  "number": 123456789
}
'

import requests

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

payload = {
    "accountTemplate": "PREPAID",
    "creditLimit": 10000,
    "number": 123456789
}
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({accountTemplate: 'PREPAID', creditLimit: 10000, number: 123456789})
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/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/v3/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([
    'accountTemplate' => 'PREPAID',
    'creditLimit' => 10000,
    'number' => 123456789
  ]),
  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/v3/customer/{customerId}"

	payload := strings.NewReader("{\n  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\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/v3/customer/{customerId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/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  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\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>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

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

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

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

Deprecated: This API endpoint is no longer supported.

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

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

accountTemplate

string

required

Template name for which the account should be connected to

Example:

"PREPAID"

creditLimit

number

Credit limit of the account

Example:

10000

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

paymentReference

object

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

Show child attributes

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

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

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 account

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/customer/{customerId}' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountTemplate": "PREPAID",
  "creditLimit": 10000,
  "number": 123456789
}
'

import requests

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

payload = {
    "accountTemplate": "PREPAID",
    "creditLimit": 10000,
    "number": 123456789
}
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({accountTemplate: 'PREPAID', creditLimit: 10000, number: 123456789})
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/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/v3/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([
    'accountTemplate' => 'PREPAID',
    'creditLimit' => 10000,
    'number' => 123456789
  ]),
  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/v3/customer/{customerId}"

	payload := strings.NewReader("{\n  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\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/v3/customer/{customerId}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v3/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  \"accountTemplate\": \"PREPAID\",\n  \"creditLimit\": 10000,\n  \"number\": 123456789\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>",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}

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

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

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