Skip to main content
PATCH
/
v4
/
PREPAID
/
{id}
Update a prepaid account
curl --request PATCH \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/PREPAID/{id}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": {
    "address1": "<string>",
    "address2": "<string>",
    "address3": "<string>",
    "address4": "<string>",
    "city": "<string>",
    "country": "FIN",
    "region": "<string>",
    "zipCode": "<string>"
  },
  "additionalValues": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "customerId": 55667788990,
  "name": "My example account name",
  "number": 123456789,
  "reason": "<string>",
  "segment": "SEGMENT_A",
  "closureReason": "CLOSED1",
  "usageLimits": [
    {
      "code": "24H",
      "values": [
        {
          "code": "ATM",
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200
        }
      ]
    }
  ],
  "paymentReference": {
    "type": "MOD10",
    "number": 1234567897
  },
  "parentId": 9876543210,
  "status": "ACCOUNT_BLOCKED"
}
'
{
  "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

​
id
string<biginteger>
required

The account id for given account

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 cr, these values will override the predefined template values

Updating set values

​
address
updateAddress · object

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

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

Customer id for account owner

Example:

55667788990

​
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

​
reason
string

Reason for contract status change

Maximum string length: 32
​
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
​
closureReason
enum<string>

Field enables to define entity's closure reason. This field will be exported but no logic is applied to this in Enfuce API

Available options:
CLOSED1,
CLOSED2,
CLOSED3,
CLOSED4,
CLOSED5
​
usageLimits
usageLimit · object[]
​
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 top account of the account hierarchy. Consult Enfuce before using this field.

Example:

9876543210

​
status
enum<string>
Available options:
ACCOUNT_BLOCKED,
ACCOUNT_OK,
ACCOUNT_TO_CLOSE

Response

Successful update 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