HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create settlement item

post
https://api.instellix.io/v2/merchant-payment-accounts//settlement-reports//settlement-items

Create a new settlement item. Every settlement item must be a part of a settlement report, created beforehand with 'Settlement Report' endpoint. New settlement item creation results in an automatic creation of a new Payment Transaction in a SETTLED status.

Path Params
string
required

Merchant payment account ident. Must not be null.

string
required

Settlement report ident. Must not be null.

Body Params

Create Settlement Item request body.

baseAmount
object
required

A monetary amount with an amount and a currency.

batchItems
array of objects | null

Sub items that are batched together in this settlement item. If specified, their sum must match the settlement item.

batchItems
date-time
required

The date of the account transaction. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used. Must not be null.

date-time | null

The date of a creation of a settlement item. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00.

string
required

Indicates whether a settlement item is a DEBIT or CREDIT. Must not be null. Must be one of:

CREDIT
DEBIT
number | null
> 0

Exchange rate used to calculate original and base amounts.

  • Exchange rate must be provided when the original currency is different from the base currency.
  • The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount, with an error margin of 0.01.
  • Exchange rate value needs to be expressed with max 5 decimals. E.g.: 4.54321.
  • If an original amount is not provided in a request, special 'self' exchange rate is automatically created with a value of 1.00000. Must be greater than or equal to 0.0. Must be a number with up to 10 integral digits and up to 5 fractional digits.
string
required
length ≤ 255

A settlement item identifier, unique within a payment account. May be provided by a PSP. Must not be blank. Size must be between 0 and 255.

fees
array of objects | null

Any fees imposed on this payment.

fees
string | null

Unique identifier of a settlement item, autogenerated by Nitrobox if omitted. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

originalAmount
object | null

A monetary amount with an amount and a currency.

string
length ≤ 255
Defaults to UNCATEGORISED
deprecated

DEPRECATED. The payment category to which a newly created payment - settled by this settlement item - is classified. This does not apply to existing payments. Must be one of the categories defined in Nitrobox, otherwise the settlement item will be rejected. Size must be between 0 and 255.

string | null

An identifier of a payment transaction which is settled with this settlement item if it is not SETTLED yet. If the transaction is already settled a new payment transaction will be created. Size must be between 0 and 255.

properties
array of objects | null

Key-value-pairs of properties of a settlement - i.e. 'GVC':'166'

properties
string | null

Information about the recipient of a settled payment. Size must be between 0 and 255.

string | null

Information about the sender of a settled payment. Size must be between 0 and 255.

string | null

In case the settlement report which is a source of this settlement item, is of a more complex format (e.g. XML file),the settlement item identifier should allow to unambiguously specify a place of a settlement item in this document. Size must be between 0 and 255.

int32 | null
> 0

In case the settlement report which is a source of this settlement item, is a simple entry based document (e.g. CSV file), the settlement line number should specify a particular line where the settlement item is placed in the file. Must be greater than 0.

string | null

Any additional information about a settlement item like purpose, description, payment title, etc. Size must be between 0 and 1400.

date-time | null

The date on which the account transaction takes effect. ISO 8601 date time format. E.g. 2021-03-19T13:34:01Z+01:00. When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.

Responses

Updated 27 days ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 27 days ago