Update status of the payment transaction

post https://api.nbx-stage-westeurope.nitrobox.io/v2/payments/{ident}/actions/update-status

If it is higher than the current status, the current status gets updated, otherwise it gets added to the history. If the history already contains this status, nothing is changed.

Responses

Response body

object

int64

Deprecated. Legacy attribute.

ident

string

An identifier of a payment transaction generated by Nitrobox.

externalIdent

string

External reference that needs to be unique within a payment account. Generally it is provided by a Payment Service Provider or a bank.

customerSpecificIdent

string

Is an optional customer specific ident, that can be used to identify this payment transaction.

creditDebitIndicator

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 be one of:

CREDIT

DEBIT

tenantId

int32

Deprecated. Legacy attribute.

paymentDescription

string

Any additional information about a payment like purpose, description, payment title, etc. This is often used for matching the payment to a document.

paymentStatus

string

required

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

RECEIVED

ERROR

REFUSED

AUTHORIZED

EXPIRED

CANCELLED

CAPTURED

CAPTURE_FAILED

SETTLED

REFUNDED

CHARGEBACK

baseAmount

object

required

The amount, that is actually transferred to this account in the accounts base currency. Represented in the same currency as an enclosing payment account.
A monetary amount with an amount and a currency.

amount

number

required

The value of this monetary amount in decimal format.
Must not be null.

currency

string

required

Currency code. Three letters ISO-4217 format.
Must not be null.

originalAmount

object

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.
A monetary amount with an amount and a currency.

amount

number

required

The value of this monetary amount in decimal format.
Must not be null.

currency

string

required

Currency code. Three letters ISO-4217 format.
Must not be null.

exchangeRate

object

Exchange rate used to calculate original and base amounts.

The rate should fulfill following calculation: originalAmount / exchangeRate = baseAmount, with an error margin of 0.01.

value

number

required

Exchange rate.

originalCurrency

string

required

original currency

targetCurrency

string

required

target/base currency

paymentAccount

object

A merchant payment account kept by a bank/PSP on behalf of its customer

int64

Deprecated. Legacy attribute.

ident

string

Unique merchant payment account identifier.

name

string

Merchant payment account name.

currency

string

Base currency of a Payment Account. Three letters ISO-4217 format.

acceptedCurrencies

array of strings

deprecated

DEPRECATED: Please use Field additionallyAcceptedCurrencies. This field was deprecated due to misleading naming compared to the MerchantPaymentAccountDto.

additionallyAcceptedCurrencies

array of strings

List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.

country

string

The country where the MerchantPaymentAccount is valid. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

paymentProvider

string

One of Payment Provider types supported in Nitrobox.
Must be one of:

ADYEN

CONTOWORKS

COMMERZBANK

GOCARDLESS

KLARNA

MOLLIE

OPTILE

STRIPE

VWFS_SMARTPAY

WORLDLINE

OTHER

paymentProviderName

string

The name of the Payment Provider that the account belongs to.

merchantPaymentAccount

object

A merchant payment account kept by a bank/PSP on behalf of its customer

int64

Deprecated. Legacy attribute.

ident

string

Unique merchant payment account identifier.

name

string

Merchant payment account name.

currency

string

Base currency of a Payment Account. Three letters ISO-4217 format.

acceptedCurrencies

array of strings

deprecated

DEPRECATED: Please use Field additionallyAcceptedCurrencies. This field was deprecated due to misleading naming compared to the MerchantPaymentAccountDto.

additionallyAcceptedCurrencies

array of strings

List of currencies accepted by the MerchantPaymentAccount in addition to the base currency.

country

string

The country where the MerchantPaymentAccount is valid. Should be a valid ISO 3166-1 alpha-3 or alpha-2 code.

paymentProvider

string

One of Payment Provider types supported in Nitrobox.
Must be one of:

ADYEN

CONTOWORKS

COMMERZBANK

GOCARDLESS

KLARNA

MOLLIE

OPTILE

STRIPE

VWFS_SMARTPAY

WORLDLINE

OTHER

paymentProviderName

string

The name of the Payment Provider that the account belongs to.

settlementIdent

string

Unique identifier of a settlement, connected to this payment transaction, autogenerated by Nitrobox.

settlementCustomerSpecificIdent

string

Is an optional customer specific ident, that can be used to identify the settlement connected to this payment transaction.

data

string

Deprecated. Legacy attribute.

bookingDate

date-time

required

The date of the account transaction. ISO 8601 date time format.

valueDate

date-time

required

The date on which the account transaction takes effect. ISO 8601 date time format.

creationDate

date-time

The date of a creation of a payment. ISO 8601 date time format.

recipient

string

The recipient of the payment transfer

sender

string

The sender of the payment transfer.

category

object

Category which a payment can be classified into. Category selection has an influence on how the payment is processed further.

int64

required

deprecated

DEPRECATED.
Id of the payment category.
Must not be null.

name

string

required

Unique category name.
Must not be null.

assignable

boolean

required

Specifies if a payment of this category can be assigned to an invoice or a creditmemo.
Must not be null.

enabled

boolean

required

Specifies if this category is enabled to be used for the tenant's payments.
Must not be null.

default

boolean

required

Specifies if a category is a default category, serving as a fallback when a payment is not classified into any of other categories.
Must not be null.

previousCategory

object

Category which a payment can be classified into. Category selection has an influence on how the payment is processed further.

int64

required

deprecated

DEPRECATED.
Id of the payment category.
Must not be null.

name

string

required

Unique category name.
Must not be null.

assignable

boolean

required

Specifies if a payment of this category can be assigned to an invoice or a creditmemo.
Must not be null.

enabled

boolean

required

Specifies if this category is enabled to be used for the tenant's payments.
Must not be null.

default

boolean

required

Specifies if a category is a default category, serving as a fallback when a payment is not classified into any of other categories.
Must not be null.

fees

array of objects

Any fees imposed on this payment.

fees

object

int64

The id of the payment transaction fee

type

string

Type of the payment transaction fee.
Must be one of:

COMMISSION

MARKUP

SCHEME_FEES

INTERCHANGE

STANDARD_FEE

amount

object

A monetary amount with an amount and a currency.

description

string

The description of the payment transaction fee

statementReference

string

Deprecated. Legacy attribute.

assignmentStatus

string

The status describing whether a payment is assigned to any document.
Must be one of:

UNASSIGNED

PARTIALLY_ASSIGNED

COMPLETELY_ASSIGNED

assignableLeftoverAmount

object

The part of a payment amount, that is actually not yet assigned to any document.
A monetary amount with an amount and a currency.

amount

number

required

The value of this monetary amount in decimal format.
Must not be null.

currency

string

required

Currency code. Three letters ISO-4217 format.
Must not be null.

history

array of objects

required

History of this payment transaction

history*

object

changeDate

date-time

required

Date of the change

status

string

required

The status this payment transaction was in.
Must be one of:

RECEIVED

ERROR

REFUSED

AUTHORIZED

EXPIRED

CANCELLED

CAPTURED

CAPTURE_FAILED

SETTLED

REFUNDED

CHARGEBACK

paymentIntentIdent

string

Payment intent ident, if a Payment was created out of this payment intent otherwise empty.

createdAt

date-time

required

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

lastModifiedAt

date-time

required

Technical last modified date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

properties

array of objects

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

properties

object

propertyIdent

string

required

Key of the property.
Must not be blank.

propertyValue

string

required

Value of the property.
Must not be null.

batchItems

array of objects

Batch items of this transaction

batchItems

object

ident

string

required

length between 1 and 100

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

externalIdent

string

A settlement batch item identifier, unique within a payment account. May be provided by a PSP.

reportLineNumber

int32

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

reportIdentifier

string

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

recipient

string

Information about the recipient of a batch item.

sender

string

Information about the sender of a batch item.

text

string

Any additional information about a batch item like purpose, description, payment title, etc.

baseAmount

object

required

An amount of money paid with this batch item. Must match settlement item base currency, otherwise the settlement item wil be rejected.
A monetary amount with an amount and a currency.

originalAmount

object

An amount of money paid with this batch item. 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 settlement item will be rejected. When original amount is not provided in a request, Batch item is created with original amount equal to the base amount.
A monetary amount with an amount and a currency.

paymentCategory

string

Name of a payment category that the payment settled with this batch item is classified to. Must be one of the categories defined in Nitrobox, otherwise the settlement item will be rejected.

properties

array of objects

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

properties

object

propertyIdent

string

required

Key of the property.
Must not be blank.

propertyValue

string

required

Value of the property.
Must not be null.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.nbx-stage-westeurope.nitrobox.io/v2/payments/ident/actions/update-status \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

202The request has been accepted for processing, but the processing has not been completed.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX