Update Invoice
The creation of a order is the first step in the accounting process of Accounting as a Service.
More information can be found in our Link
Path
POST /businesses/{businessCode}/customers/{customerNumber}/orders/{orderReference}/invoices/{invoiceReference} Request Parameters
businessCode
required
string
The business in the context of which this request is to be executed, e.g. 1000
customerNumber
required
string
The customer in the context of which this request is to be executed, e.g. TFI2021072801
orderReference
required
string
The order in the context of which this request is to be executed, e.g. TFI2021072801_03
invoiceReference
required
string
The invoice in the context of which this request is to be executed, e.g. IDE12345678901
X-Request-ID
string
The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.
Request Body
application/json
goodwillReference
string
Max length: 30
maxLength(30)
Reference to use for goodwill which is automatically created to nullify the original invoice.
Reference to use for goodwill which is automatically created to nullify the original invoice.
object
carrier
required
string
Carrier code (will be required for efficient chargeback handling).
Only required for physical goods and if order is shipped when this information is generated.
dispatchDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date of shipment
Date of shipment
dueDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the invoice is due
Date the invoice is due
invoiceDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the invoice number has been created
Date the invoice number has been created
invoiceReference
required
string
Max length: 30
maxLength(30)
Invoice number of referenced invoice
Invoice number of referenced invoice
array
The items that are to be invoiced
orderItemReference
required
integer
Values(1-999999)
External reference of the line item in the original order
External reference of the line item in the original order
shipmentReference
required
string
Max length: 30
maxLength(30)
Specific shipment reference from merchant
Specific shipment reference from merchant
trackingCode
required
string
Tracking code of parcel (will be required for efficient chargeback handling).
Only required for physical goods and if order is shipped when this information is generated.
object
billToAddress
object
carrier
string
Max length: 32
maxLength(32)
Name of the Carrier. Required for chargeback handling
Name of the Carrier. Required for chargeback handling
object
CompanyTAXNo
string
Max length: 20
TAX No of the company paying the bill.
object
additionalAddressLine
string
Max length: 40
maxLength(40)
Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'
Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'
countryCode
string
Format([A-Z]{2})
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)
Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)
postalCode
string
Max length: 10
maxLength(10)
Postal code
Postal code
postalPlace
string
Max length: 40
maxLength(40)
Postal place, e.g. city
Postal place, e.g. city
street
string
Max length: 60
maxLength(60)
Name of street or packstation
Name of street or packstation
streetNumber
string
Max length: 10
maxLength(10)
Street or packstation number
Street or packstation number
companyName
required
string
Max length: 140
Full Company Name (including 'GmbH', 'AG', ...).
companyVATId
required
string
Max length: 20
VAT-ID of the company.
email
string
Max length: 241
Email address of the company for billing communication.
language
string
Max length: 2
Language Code of the Company for correspondence.
mobile
string
Max length: 27
Optional mobile number of the company.
phone
string
Max length: 27
Optional phone number of the company.
object
basicCharge
number
Values(>0)
Basic charge of this contract (in the currency of this contract)
Basic charge of this contract (in the currency of this contract)
contractID
required
string
Max length: 40
maxLength(40)
Contract number. Has to be unique per business.
Contract number. Has to be unique per business.
customerContractEndDate
string
yyyy-MM-dd
Format(yyyy-MM-dd)
End date of business relationship
End date of business relationship
customerContractStartDate
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Start date of business relationship
Start date of business relationship
description
string
Max length: 50
maxLength(50)
Description of the contract (e.g. product name)
Description of the contract (e.g. product name)
endDate
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the contract ends
Date the contract ends
minimumTerm
integer
Values(0-99)
Minimum contract length in months
Minimum contract length in months
startDate
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Start date of the contract
Start date of the contract
currency
required
string
Format([A-Z]{3})
Currency used in order (encoded as 3-letter code according to ISO 4217)
Currency used in order (encoded as 3-letter code according to ISO 4217)
array
description
string
Max length: 40
maxLength(40)
Name or title of product
Name or title of product
grossUnitPrice
number
Gross unit price (incl. VAT) of item
netAmount
number
Net Amount of item
netAmountEUR
number
Net unit price (incl. VAT) of item (in EUR)
quantity
number
Values(>0)
Quantity
Quantity
vatAmount
number
Tax value of country tax
vatPercent
number
Values(0-100)
Tax rate of country tax in %
Tax rate of country tax in %
additionalInvoiceInformation
string
Max length: 255
maxLength(255)
Additional information for the invoice
Additional information for the invoice
grossTotalPrice
number
Gross total price (incl. VAT) of item position
netTotalPriceInfo
number
Net total price (excl. VAT) of item position. For information only!
netUnitPriceInfo
number
Net unit price (excl. VAT) of item position. For information only!
orderItemReference
required
integer
Values(1-999999)
External reference of the line item in the order
External reference of the line item in the order
positionType
string
Enum:
- IBAN_VERIFICATION
- LOYALTY_CARD
- SHIPPING_COSTS_EXPRESS
- FREE_ARTICLE
- GIFT_CARD_VOUCHER_PAYMENT
- GIFT_CARD_VOUCHER_SALE
- SERVICE_CHARGE
- CASH_ON_DELIVERY
- MARKETPLACE_PROVISION
- SUBSCRIPTION_ORDER
- SUBSCRIPTION_ORDER_2
- SALES_ARTICLE
- DISCOUNT
- SHIPPING_COSTS
- DISCOUNT_FOR_SUBSCRIPTION_ORDER
- NOT_ACCOUNTING_RELEVANT
- CREDIT_NOTE
Type of product:
* IBAN_VERIFICATION = IBAN verification
* LOYALTY_CARD = Loyalty Card
* SHIPPING_COSTS_EXPRESS = Shipping costs (express)
* FREE_ARTICLE = Free article
* GIFT_CARD_VOUCHER_PAYMENT = Gift Card Voucher Payment
* GIFT_CARD_VOUCHER_SALE = Gift Card Voucher Sale
* SERVICE_CHARGE = Service Charge
* CASH_ON_DELIVERY = Cash on delivery
* MARKETPLACE_PROVISION = Marketplace-Provision
* SUBSCRIPTION_ORDER = Subscription Order
* SALES_ARTICLE = Sales Article
* DISCOUNT = Discount
* SHIPPING_COSTS = Shipping costs
* DISCOUNT_FOR_SUBSCRIPTION_ORDER = Discount for Subscription Order
* NOT_ACCOUNTING_RELEVANT = Not accounting relevant
productId
string
Max length: 30
maxLength(30)
Article number of line item
Article number of line item
object
endDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the subscription ends; required for booking of deferred income
Date the subscription ends; required for booking of deferred income
startDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Start date of the subscription
Start date of the subscription
unitType
string
Enum:
- ST
- KWH
- MIN
- FLT
Type of unit (quantityType):
* ST = piece
* KWH = KiloWattHour
* MIN = Minute
* FLT = Flat
vatType
required
string
Enum:
- TAXLESS
- NORMAL
- REDUCED
- REVERSE
Type of VAT
* TAXLESS = taxless
* NORMAL = normal
* REDUCED = reduced
* REVERSE = reversed
orderChannel
required
string
Enum:
- ECOM
- MOTO
- MOBILE
- POS
- APP
- P2P
Sales channel used:
* ECOM = eCom (default)
* MOTO = MoTo (MailOrder TelephoneOrder)
* MOBILE = Mobile
* POS = POS
* APP = Application
* P2P = P2P
orderDate
required
string
yyyy-MM-dd
Format(yyyy-MM-dd)
Date the order has been placed
Date the order has been placed
orderReference
required
string
Max length: 16
maxLength(16)
Specific order reference from merchant (alphanumeric characters, only)
Specific order reference from merchant (alphanumeric characters, only)
orderType
required
string
Enum:
- PHYSICAL_GOODS
- DIGITAL_GOODS
- BANK_VERIFICATION
Defines the type of order resp. delivery being made:
* PHYSICAL_GOODS = physical goods
* DIGITAL_GOODS = digital goods
* BANK_VERIFICATION = bank verification
object
POSPayment
required
object
externalPaymentToken
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- POSPayment
'POSPayment'
AfterPayDirectDebit
required
object
accountOwner
string
Name of the bank account owner
authorizationDate
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
bic
string
Max length: 16
BIC / SWIFT code
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
iban
string
Max length: 50
IBAN used for the transaction
mandateReference
string
Reference of the SEPA Mandate
mandateReferenceText
string
Reference text which appears on the end customers bank account statement
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- AfterPayDirectDebit
'AfterPayDirectDebit'
AfterPayInstallmentsDirectDebit
required
object
accountOwner
string
Name of the bank account owner
authorizationDate
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
bic
string
Max length: 16
BIC / SWIFT code
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
iban
string
Max length: 50
IBAN used for the transaction
mandateReference
string
Reference of the SEPA Mandate
mandateReferenceText
string
Reference text which appears on the end customers bank account statement
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- AfterPayInstallmentsDirectDebit
'AfterPayInstallmentsDirectDebit'
AfterPayInstallmentsOpenInvoice
required
object
accountOwner
string
Name of the bank account owner
authorizationDate
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
bic
string
Max length: 16
BIC / SWIFT code
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
iban
string
Max length: 50
IBAN used for the transaction
mandateReference
string
Reference of the SEPA Mandate
mandateReferenceText
string
Reference text which appears on the end customers bank account statement
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- AfterPayInstallmentsOpenInvoice
'AfterPayInstallmentsOpenInvoice'
AfterPayOpenInvoice
required
object
accountOwner
string
Name of the bank account owner
authorizationDate
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
bic
string
Max length: 16
BIC / SWIFT code
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
iban
string
Max length: 50
IBAN used for the transaction
mandateReference
string
Reference of the SEPA Mandate
mandateReferenceText
string
Reference text which appears on the end customers bank account statement
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- AfterPayOpenInvoice
'AfterPayOpenInvoice'
AmazonPay
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- AmazonPay
'AmazonPay'
AmericanExpress
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- AmericanExpress
'AmericanExpress'
ApplePayExpressCheckout
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- ApplePayExpressCheckout
'ApplePayExpressCheckout'
ArvatoDirectDebitSepa
required
object
accountOwner
required
string
Name of the bank account owner
authorizedAmount
required
number
Authorized amount for this order
bic
string
Max length: 16
BIC / SWIFT Code
iban
required
string
Max length: 50
IBAN used for the transaction
mandateReference
required
string
Reference of the SEPA Mandate
mandateReferenceText
string
Reference text which appears on the end customers bank account statement
paymentMethodName
required
string
Enum:
- ArvatoDirectDebitSepa
'ArvatoDirectDebitSepa'
Bancontact
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Bancontact
'Bancontact'
Blik
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Blik
'Blik'
BlikCodeOnly
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- BlikCodeOnly
'BlikCodeOnly'
CashOnDelivery
paymentMethodName
required
string
Enum:
- CashOnDelivery
'CashOnDelivery'
DinersClub
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- DinersClub
'DinersClub'
Discover
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- Discover
'Discover'
Eps
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Eps
'Eps'
Giftcard
paymentMethodName
required
string
Enum:
- Giftcard
'Giftcard'
Giropay
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Giropay
'Giropay'
GooglePay
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- GooglePay
'GooglePay'
Ideal
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Ideal
'Ideal'
InAppAmazon
required
object
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- InAppAmazon
'InAppAmazon'
InAppApple
required
object
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- InAppApple
'InAppApple'
InAppGoogle
required
object
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- InAppGoogle
'InAppGoogle'
InStoreOpenInvoice
paymentMethodName
required
string
Enum:
- InStoreOpenInvoice
'InStoreOpenInvoice'
InStorePickup
paymentMethodName
required
string
Enum:
- InStorePickup
'InStorePickup'
InStorePrepayment
paymentMethodName
required
string
Enum:
- InStorePrepayment
'InStorePrepayment'
Klarna
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Klarna
'Klarna'
KlarnaDirectDebit
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- KlarnaDirectDebit
'KlarnaDirectDebit'
KlarnaInstallments
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- KlarnaInstallments
'KlarnaInstallments'
KlarnaOpenInvoice
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- KlarnaOpenInvoice
'KlarnaOpenInvoice'
KlarnaPayLater
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- KlarnaPayLater
'KlarnaPayLater'
KlarnaPayOverTime
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
cardHolder
string
Card owner
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- KlarnaPayOverTime
'KlarnaPayOverTime'
LoyaltyCard
paymentMethodName
required
string
Enum:
- LoyaltyCard
'LoyaltyCard'
MasterCard
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- MasterCard
'MasterCard'
Multibanco
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Multibanco
'Multibanco'
OpenInvoice
paymentMethodName
required
string
Enum:
- OpenInvoice
'OpenInvoice'
OpenBankingIvy
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- OpenBankingIvy
'OpenBankingIvy'
PayPal
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- PayPal
'PayPal'
PayPalExpressCheckout
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- PayPalExpressCheckout
'PayPalExpressCheckout'
PayU
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- PayU
'PayU'
PrePayment
paymentMethodName
required
string
Enum:
- PrePayment
'PrePayment'
Przelewy24
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Przelewy24
'Przelewy24'
Sofort
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Sofort
'Sofort'
StripeCollected
required
object
externalPaymentToken
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- StripeCollected
'StripeCollected'
Scalapay
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Scalapay
'Scalapay'
Swish
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Swish
'Swish'
Trustly
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Trustly
'Trustly'
Visa
required
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
The timestamp when authorization occurred.
authorizedAmount
required
number
The authorized amount for the transaction.
cardHolder
string
Name of the card owner.
cardType
string
The type of credit card being used:
* VI = Visa / Google Pay / Apple Pay
* MC = Mastercard
* AM = American Express
* DI = Diners
* DS = Discover
object
Expiry date of the payment instrument
month
required
integer
Values(1-12)
Month component of the expiry date
Month component of the expiry date
year
required
integer
Values(1970-9999)
Year component of the expiry date
Year component of the expiry date
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider.
merchantAccountId
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext.
settlementReference
required
string
Reference ID for settlement with the PSP.
paymentMethodName
required
string
Enum:
- Visa
'Visa'
PaaSOpenInvoice
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- PaaSOpenInvoice
'PaaSOpenInvoice'
Twint
object
authorizationDate
required
string
yyyy-MM-ddTHH:mm:ss.fffffffzzz
Date and time the amount has been authorized
authorizedAmount
required
number
Authorized amount for this order
externalPaymentToken
required
string
Transaction ID generated via another (third-party) payment provider
merchantAccountId
required
string
Merchant code of the external PSP (used for the authorization with the PSP through PayNext)
settlementReference
required
string
OrderID used in communication with PSP
paymentMethodName
required
string
Enum:
- Twint
'Twint'
processAfterDunning
string
Enum:
- HAND_OVER_FOR_DEBT_COLLECTION
- HAND_OVER_FOR_FACTORING
Decision if overdue orders should be sold or handed over for debt collection:
* HAND_OVER_FOR_DEBT_COLLECTION = hand over for debt collection
* HAND_OVER_FOR_FACTORING = hand over for factoring
object
Additional information that may be used later for reporting purposes
genericField1
string
Max length: 50
maxLength(50)
Merchant-specific generic information which can be used for reporting purposes
Merchant-specific generic information which can be used for reporting purposes
genericField2
string
Max length: 50
maxLength(50)
Merchant-specific generic information which can be used for reporting purposes
Merchant-specific generic information which can be used for reporting purposes
genericField3
string
Max length: 25
maxLength(25)
Merchant-specific generic information which can be used for reporting purposes
Merchant-specific generic information which can be used for reporting purposes
genericField4
string
Max length: 25
maxLength(25)
Merchant-specific generic information which can be used for reporting purposes
Merchant-specific generic information which can be used for reporting purposes
genericField5
string
Max length: 25
maxLength(25)
Merchant-specific generic information which can be used for reporting purposes
Merchant-specific generic information which can be used for reporting purposes
shipToAddress
object
supplyingCountry
required
string
Format([A-Z]{2})
Country of origin of the shipment (encoded as ISO 3166-1 alpha-2)
Country of origin of the shipment (encoded as ISO 3166-1 alpha-2)
trackingCode
string
Max length: 32
maxLength(31)
Tracking code of parcel. Required for chargeback handling
Tracking code of parcel. Required for chargeback handling
vatDeclarationCountry
required
string
Format([A-Z]{2})
Country in which the tax has to be declared (encoded as 2-letter code according to ISO 3166-1 alpha-2)
Country in which the tax has to be declared (encoded as 2-letter code according to ISO 3166-1 alpha-2)
Responses
-
internalRequestIdrequiredstringThe internal ID (i.e. receipt) of the message as received by the system
-
arrayactionstringExternal action to be triggered based on error code/messagecodestringCode of third party error.customerFacingMessagestringCustomer facing message of third party error.descriptionstringDescription of third party error.fieldReferencestringField reference of third party error.sourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitle of third party error.typestringType or class of third party error.codestringError code.descriptionstringError description.titlestringError title.typestringError type.
-
arrayactionstringExternal action to be triggered based on error code/messagecodestringCode of third party error.customerFacingMessagestringCustomer facing message of third party error.descriptionstringDescription of third party error.fieldReferencestringField reference of third party error.sourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitle of third party error.typestringType or class of third party error.codestringError code.descriptionstringError description.titlestringError title.typestringError type.
Request Example
{
"order": {
"items": [
{
"vatType": "NORMAL",
"quantity": 2.5,
"productId": "BEF12346512A/1",
"vatAmount": 19.02,
"vatPercent": 19,
"description": "Lizenz zum Buchen",
"positionType": "SHIPPING_COSTS_EXPRESS",
"subscription": {
"endDate": "2019-03-15",
"startDate": "2018-12-05"
},
"grossUnitPrice": 119.12,
"orderItemReference": 3,
"reportingPositionData": {
"genericField1": "string",
"genericField2": "string",
"genericField3": "string",
"genericField4": "string",
"genericField5": "string",
"giftCardVoucherId": "298uwfj88"
}
}
],
"contract": {
"endDate": "2019-03-15",
"startDate": "2018-12-05",
"contractID": "A545axe58",
"basicCharge": 12,
"description": "10 month contract",
"minimumTerm": 3,
"customerContractEndDate": "2016-01-09",
"customerContractStartDate": "2015-12-10"
},
"currency": "EUR",
"orderDate": "2015-12-10",
"orderType": "PHYSICAL_GOODS",
"orderChannel": "ECOM",
"billToAddress": {
"email": "max.mustermann@outlook.com",
"phone": "+491345789555",
"title": "DR",
"careOf": "Jane c/o John",
"street": "Beispielstr.",
"language": "de",
"lastName": "Mustermann",
"birthDate": "1983-09-15",
"firstName": "Max",
"postalCode": "48213",
"salutation": "MRS",
"countryCode": "DE",
"nationality": "DE",
"postalPlace": "Muenster",
"streetNumber": "13A",
"customerGroup": "Gold Clients",
"taxIdentificationNumber": "DE999999999"
},
"reportingData": {
"genericField1": "string",
"genericField2": "string",
"genericField3": "string",
"genericField4": "string",
"genericField5": "string"
},
"shipToAddress": {
"state": "AL",
"title": "DR",
"careOf": "Jane c/o John",
"street": "Beispielstr.",
"language": "de",
"lastName": "Mustermann",
"firstName": "Max",
"postalCode": "48213",
"salutation": "MRS",
"countryCode": "DE",
"postalPlace": "Muenster",
"streetNumber": "13A"
},
"orderReference": "ODE12345678901",
"paymentReference": {
"paymentDetails": {
"bic": "GENODEM1MSC",
"iban": "DE51100100501234567890",
"accountOwner": "Max Mustermann",
"authorizedAmount": 152.39,
"mandateReference": "321654984",
"authorizationDate": "2018-11-05T16:15:03Z",
"merchantAccountId": "ECOM_PAYPAL",
"arvatoPaymentToken": "438674718468",
"settlementReference": "ODE12340849323",
"mandateReferenceText": "OrderNo. 1234 Customer 3422"
},
"paymentMethodName": "ArvatoDirectDebitSepa"
},
"supplyingCountry": "DE",
"processAfterDunning": "HAND_OVER_FOR_DEBT_COLLECTION",
"vatDeclarationCountry": "DE"
},
"invoice": {
"items": [
{
"orderItemReference": 3
}
],
"carrier": "DHL",
"dueDate": "2018-11-05",
"invoiceDate": "2018-11-04",
"dispatchDate": "2018-11-06",
"trackingCode": "123456asfd788754sdffs987",
"invoiceReference": "IDE12345678901",
"shipmentReference": "S01234567"
},
"goodwillReference": "GDE12345678901"
}
Response Example
{
"internalRequestId": "23c9579b-baaf-468f-a529-f876226e183c"
}