Post transactions to given account

POST

account

{accountId}

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transaction/v3/account/{accountId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "amount": 123,
  "currency": "EUR",
  "text": "<string>",
  "additionalInfo": {
    "ref": "<string>",
    "message": "<string>",
    "paymentReceiver": "<string>",
    "transferId": "<string>",
    "text": "<string>",
    "discLinkTransactionId": "<string>",
    "discLinkPurchaseDetailId": "<string>",
    "paymentReference": "<string>",
    "payerName": "<string>",
    "fromAddress": "<string>",
    "fromZip": "<string>",
    "fromCity": "<string>",
    "fromBankAccountNumber": "<string>",
    "fromCustomerAccountNumber": "<string>",
    "fromOrganizationalNumber": "<string>",
    "fromBankName": "<string>",
    "toBic": "<string>",
    "fromBankAccountType": "BBAN",
    "toBankAccountType": "BBAN",
    "toBankAccountNumber": "<string>",
    "fileName": "<string>",
    "receivedFromCollectionAgency": true,
    "vatRate": "<string>",
    "vatAmount": "<string>",
    "billNumber": "<string>"
  },
  "transactionDetails": "<string>",
  "date": "2023-12-25",
  "postingDate": "2023-12-25",
  "transactionDate": "2023-12-25"
}
'

{
  "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

accountId

string<biginteger>

required

The account id to post transactions to

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

type

string

required

Transaction type

amount

number

required

Transaction amount. It is possible to post only amount which is equal or more than minimal currency unit (For example, for EUR, SEK, NOK minimal unit is 0,01)

currency

string

required

A valid ISO 4217 currency code

Example:

"EUR"

text

string

Free input text

Maximum string length: 255

additionalInfo

additionalInfo · object

Show child attributes

additionalInfo.ref

string

Reference number

additionalInfo.message

string

Message text field

additionalInfo.paymentReceiver

string

Payment receiver name

additionalInfo.transferId

string

Transfer id

additionalInfo.text

string

Free text

additionalInfo.discLinkTransactionId

string

The transactionId of the original financial transaction of this discount

additionalInfo.discLinkPurchaseDetailId

string

The purchaseDetailsId of the original purchase detail of this discount

additionalInfo.paymentReference

string

Reference number used for the transaction

additionalInfo.payerName

string

First and last name of payer

additionalInfo.fromAddress

string

Address of payer

additionalInfo.fromZip

string

Zip code of payer

additionalInfo.fromCity

string

City of payer

additionalInfo.fromBankAccountNumber

string

Source account number

additionalInfo.fromCustomerAccountNumber

string

from the Enfuce system, where the payment was posted

additionalInfo.fromOrganizationalNumber

string

Sender Organizational number

additionalInfo.fromBankName

string

Source bank name

additionalInfo.toBic

string

Target BIC code, used for pain file generation

additionalInfo.fromBankAccountType

enum<string>

The type of bank account

Available options:

BBAN,

IBAN,

PLUSGIRO,

BANKGIRO

additionalInfo.toBankAccountType

enum<string>

The type of bank account

Available options:

BBAN,

IBAN,

PLUSGIRO,

BANKGIRO

additionalInfo.toBankAccountNumber

string

Target account number

additionalInfo.fileName

string

Name of processed file, typically for managing incoming payments.

additionalInfo.receivedFromCollectionAgency

boolean

Whether a collection payment transaction (CPT) is received from a collection agency or not. Only applies to payment transactions for invoices in collection.

additionalInfo.vatRate

string

Vat rate

additionalInfo.vatAmount

string

Vat amount

additionalInfo.billNumber

string

Bill number

transactionDetails

string

Merchant name

Maximum string length: 255

date

string<date>

The date when transaction was posted at Enfuce in ISO-8601 date format (YYYY-MM-DD). Only one of date or postingDate can be used at a time. This field will always post a transaction even if this date is not valid.

postingDate

string<date>

The date when transaction was posted at Enfuce in ISO-8601 date format (YYYY-MM-DD). Only one of date or postingDate can be used at a time. When using this field an exception will be thrown if posting date is not valid. For a postingDate to be valid, it must be no later than the due date of the account's contract.

transactionDate

string<date>

The local date when the transaction was made in ISO-8601 date format (YYYY-MM-DD).

Response

Successful creation of transaction

description

string

Short description of the result of the action

string

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

⌘I

Post transactions to given account

curl --request POST \
  --url 'https://integration-api-cat2.{{environment}}.ext.{{realm}}.cia.enfuce.com/transaction/v3/account/{accountId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "<string>",
  "amount": 123,
  "currency": "EUR",
  "text": "<string>",
  "additionalInfo": {
    "ref": "<string>",
    "message": "<string>",
    "paymentReceiver": "<string>",
    "transferId": "<string>",
    "text": "<string>",
    "discLinkTransactionId": "<string>",
    "discLinkPurchaseDetailId": "<string>",
    "paymentReference": "<string>",
    "payerName": "<string>",
    "fromAddress": "<string>",
    "fromZip": "<string>",
    "fromCity": "<string>",
    "fromBankAccountNumber": "<string>",
    "fromCustomerAccountNumber": "<string>",
    "fromOrganizationalNumber": "<string>",
    "fromBankName": "<string>",
    "toBic": "<string>",
    "fromBankAccountType": "BBAN",
    "toBankAccountType": "BBAN",
    "toBankAccountNumber": "<string>",
    "fileName": "<string>",
    "receivedFromCollectionAgency": true,
    "vatRate": "<string>",
    "vatAmount": "<string>",
    "billNumber": "<string>"
  },
  "transactionDetails": "<string>",
  "date": "2023-12-25",
  "postingDate": "2023-12-25",
  "transactionDate": "2023-12-25"
}
'

{
  "description": "<string>",
  "id": "<string>"
}