Update a debit account

PATCH

DEBIT

{id}

curl --request PATCH \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}' \
  --header 'Authorization: Basic <encoded-value>' \
  --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>",
  "usageLimits": [
    {
      "values": [
        {
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200
        }
      ]
    }
  ]
}
'

import requests

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

payload = {
    "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>",
    "usageLimits": [{ "values": [
                {
                    "reset": True,
                    "singleAmount": 1000,
                    "count": 5,
                    "sumAmount": 1200
                }
            ] }]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
    usageLimits: [{values: [{reset: true, singleAmount: 1000, count: 5, sumAmount: 1200}]}]
  })
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}', 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/DEBIT/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
    'usageLimits' => [
        [
                'values' => [
                                [
                                                                'reset' => true,
                                                                'singleAmount' => 1000,
                                                                'count' => 5,
                                                                'sumAmount' => 1200
                                ]
                ]
        ]
    ]
  ]),
  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/DEBIT/{id}"

	payload := strings.NewReader("{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\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"
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "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

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.

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

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[]

Show child attributes

paymentReference

object

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

Show child attributes

status

enum<string>

Available options:

ACCOUNT_BLOCKED,

ACCOUNT_OK,

ACCOUNT_TO_CLOSE

Response

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

Update a debit account

curl --request PATCH \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}' \
  --header 'Authorization: Basic <encoded-value>' \
  --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>",
  "usageLimits": [
    {
      "values": [
        {
          "reset": true,
          "singleAmount": 1000,
          "count": 5,
          "sumAmount": 1200
        }
      ]
    }
  ]
}
'

import requests

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

payload = {
    "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>",
    "usageLimits": [{ "values": [
                {
                    "reset": True,
                    "singleAmount": 1000,
                    "count": 5,
                    "sumAmount": 1200
                }
            ] }]
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
    usageLimits: [{values: [{reset: true, singleAmount: 1000, count: 5, sumAmount: 1200}]}]
  })
};

fetch('https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}', 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/DEBIT/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
    'usageLimits' => [
        [
                'values' => [
                                [
                                                                'reset' => true,
                                                                'singleAmount' => 1000,
                                                                'count' => 5,
                                                                'sumAmount' => 1200
                                ]
                ]
        ]
    ]
  ]),
  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/DEBIT/{id}"

	payload := strings.NewReader("{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/account/v4/DEBIT/{id}")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"address1\": \"<string>\",\n    \"address2\": \"<string>\",\n    \"address3\": \"<string>\",\n    \"address4\": \"<string>\",\n    \"city\": \"<string>\",\n    \"country\": \"FIN\",\n    \"region\": \"<string>\",\n    \"zipCode\": \"<string>\"\n  },\n  \"additionalValues\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\"\n    }\n  ],\n  \"customerId\": 55667788990,\n  \"name\": \"My example account name\",\n  \"number\": 123456789,\n  \"reason\": \"<string>\",\n  \"usageLimits\": [\n    {\n      \"values\": [\n        {\n          \"reset\": true,\n          \"singleAmount\": 1000,\n          \"count\": 5,\n          \"sumAmount\": 1200\n        }\n      ]\n    }\n  ]\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"
}

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