Skip to main content
POST
/
v4
/
PREPAID
/
customer
/
{customerId}
Create prepaid account
curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/PREPAID/customer/{customerId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "address1": "Kings street 12",
    "city": "Mariehamn",
    "country": "FIN",
    "zipCode": 22100,
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "region": "Åland Islands"
  },
  "additionalValues": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "name": "My example account name",
  "number": 123456789,
  "segment": "SEGMENT_A",
  "paymentReference": {
    "type": "MOD10",
    "number": 1234567897
  },
  "parentId": 9876543210,
  "productCode": "CARD_EUR_FI"
}
'
{
  "description": "<string>",
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

​
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

​
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
​
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

​
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

​
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.

Example:

"CARD_EUR_FI"

Response

Successful creation of the account

​
description
string

Short description of the result of the action

​
id
string

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