HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create payment transaction

post
https://api.instellix.io/v2/merchant-payment-accounts//payments

Create a new payment transaction on this merchant payment account.

Path Params
string
required

Merchant payment account ident.

Body Params

A payment transaction describes a financial transaction that happened on a payment account.

baseAmount
object
required

The amount, that is actually transferred to this account in the accounts base currency. Must be represented
in the same currency as an enclosing payment account, otherwise the payment transaction request will be rejected.

batchItems
array of objects | null

List of batch items that will be updated

batchItems
date-time
required

The date of the account transaction. ISO 8601 date time format.
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 payment. ISO 8601 date time format.
When no offset is provided (e.g. 2021-03-19T13:34:01), UTC is automatically used.

string
required

A description, whether this payment transaction is a DEBIT, removing money from the account or a CREDIT,
adding money to the account.
Must not be null.
Must be one of:

CREDIT
DEBIT
string | null

Is an optional customer specific ident, that can be used to identify this payment transaction.
Size must be between 0 and 255.

number | null
0 to 100000000000000

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 12 decimals. E.g.: 4.543210987654.
  • If an original amount is not provided in a request, special 'self' exchange rate is automatically created with a value of 1.000000000000.
    Must be greater than or equal to 0.
    Must be less than or equal to 100000000000000.
    Must be a number with up to 14 integral digits and up to 12 fractional digits.
string
required
length between 1 and 255
^\S(.*\S)?$

External reference that needs to be unique within a payment account. Generally it is provided
by a Payment Service Provider or a bank. Cannot be amended after the initial POST.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

fees
array of objects | null

Any fees imposed on this payment.

fees
string | null
[a-zA-Z0-9_.~-]*

Unique identifier of a payment transaction, autogenerated by Nitrobox if omitted.
Size must be between 1 and 100.
Must match with the regular expression '[a-zA-Z0-9_.~-]*'.

originalAmount
object | null

The original amount, that was transferred to this account before converting it to the accounts base currency.
Represented in the original currency of a transaction.
In case original currency is different than the base currency, an exchange rate must also be provided,
otherwise the payment transaction will be rejected. When original amount is not provided in a request, payment is
created with original amount equal to the base amount.

string
required
length between 1 and 255
^\S(.*\S)?$

Name of a payment category that this payment is classified to.
Must be one of the categories defined in Nitrobox, otherwise the payment will be rejected.
Category selection have an influence on how the payment is processed further.
Must not be null.
Size must be between 1 and 255.
Must match with the regular expression '^\S(.*\S)?$'.

properties
array of objects | null

Key-Value-Pairs of properties of a settlement - i.e. 'GVC':'166'

properties
string | null

The recipient of the payment transfer.
Size must be between 0 and 255.

string | null

The sender of the payment transfer.
Size must be between 0 and 255.

string
required

The status this payment transaction is in.
Must not be null.
Must be one of:

RECEIVED
ERROR
REFUSED
AUTHORIZED
EXPIRED
CANCELLED
CAPTURED
CAPTURE_FAILED
SETTLED
REFUNDED
CHARGEBACK
string | null

Any additional information about a payment like purpose, description, payment title, etc.
This is often used for matching the payment to a document.
Size must be between 0 and 1400.

date-time
required

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

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 months ago

Did this page help you?