Retrieve PaymentIntent

get https://api.nbx-stage-westeurope.nitrobox.io/v2/payment-intents/{paymentIntentIdent}

Get a PaymentIntent by its ident.

Responses

Response body

object

ident

string

An identifier of this PaymentIntent.

type

string

The type of PaymentIntent.
Must be one of:

CHARGING

REFUND

PAYOUT

status

string

Current PaymentIntentStatus.
Must be one of:

CREATED

IN_PROGRESS

RETRY

FAILED

SUBMITTED

CANCELLED

PROCESSED

amount

object

An amount which shall be used for the PaymentIntent.
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.

referenceType

string

Type of the referenced entity.

referenceIdent

string

An identifier of the referenced entity.

statementDescriptor

string

The descriptor to be used for the PaymentIntent.

paymentTransaction

object

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

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.

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.

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.

paymentAccount

object

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

merchantPaymentAccount

object

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

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.

previousCategory

object

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

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.

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.

customerPaymentAccountDto

object

A CustomerPaymentAccount with payment details that is assigned to a specific debtorIdent.

tenantId

int64

Unique internal reference to identify the Tenant.

ident

string

required

length between 1 and 100

Unique internal reference to identify this CustomerPaymentAccount.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

debtorIdent

string

required

length between 1 and 100

Unique external reference to identify the Debtor.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

displayName

string

length between 0 and 255

Name for the customer payment account displayed on invoices. Do not send full payment data like credit card no, IBAN, etc. (e.g. "** ** ** 234").
Size must be between 0 and 255.

paymentMethod

string

Payment method associated with the customerPaymentAccount via the paymentProviderReference. The specification is only for further explanation and has no effect on the actual selection of the payment method. This is determined entirely by specifying the paymentProviderReference or additionally by the paymentMethodReference.
Must be one of:

DIRECT_DEBIT

CREDIT_CARD

PAY_PAL

paymentMethodReference

string

length between 0 and 255

External reference to identify the authorization or mandate of the payment method at the payment provider. This is optional because some payment providers require a general customer reference (paymentProviderReference) and a payment method reference (paymentMethodReference) in order to process a payment.
Size must be between 0 and 255.

paymentProviderReference

string

required

length between 0 and 255

External reference to identify the account at the payment provider. For example the IBAN when using DIRECT_DEBIT as PaymentProviderType.
Must not be null.
Size must be between 0 and 255.

accountHolderName

string

length between 0 and 255

Account holder name used for the charging.
Size must be between 0 and 255.

accountCreationDate

date-time

Date when the payment account was created at the payment provider. Required e.g. for some external mandate managements in the SEPA environment.

healthStatus

string

Health status of this customer payment account.
Must be one of:

GOOD

AVERAGE

POOR

merchantPaymentGatewayIdent

string

required

length between 1 and 100

Unique reference to identify the merchant payment gateway that is associated with this account.
Must not be null.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

billingGroupIdent

string

An identifier of a billing group.

dateCreated

date-time

deprecated

DEPRECATED please use createdAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.

dateModified

date-time

deprecated

DEPRECATED please use lastModifiedAt. Removal planned after 2025-06-01. The date-time format was missing the timezone offset.

createdAt

date-time

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

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).

paymentIntentResponse

array of objects

Payment intent responses

paymentIntentResponse

object

ident

string

Unique identifier of the payment intent response.

paymentIntentIdent

string

Identifier of the corresponding payment intent.

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.

status

string

Outcome of the processing at the PSP.
Must be one of:

SUCCEEDED

FAILED

INFO

statusMessage

string

Optional message about the outcome of the processing at the PSP.

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.

baseAmount

object

originalAmount

object

A monetary amount with an amount and a currency.

exchangeRate

number

Exchange rate used to calculate original and base amounts.

categoryName

string

Name of a payment category that this payment is classified to. Category selection have an influence on how the payment is processed further.

sender

string

The sender of the payment transfer.

recipient

string

The recipient of the payment transfer

businessSegmentIdent

string

deprecated

An identifier of business segment. DEPRECATED: use billingGroupIdent

referenceKey

string

deprecated

DEPRECATED.
Type of the referenced entity. Please use referenceType

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.nbx-stage-westeurope.nitrobox.io/v2/payment-intents/paymentIntentIdent \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Standard response for successful HTTP requests.

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

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