Order field definitions for Create Order and Create Async Order
| Field Name | Mandatory | Definition | Example |
|---|---|---|---|
| order.state_flow | no, but recommended | Determines the order status flow applied to the order. Always use authorization_flow value. | authorization_flow |
| order.success_url | yes | The URL of success page to which the buyer will be redirected after he authorizes the order in Mondu Hosted Checkout Page. This callback will be triggered if the order gets the authorized state. Mondu will add a parameter order_uuid to the url upon the redirect. | https://success_page_url/shop.com |
| order.declined_url | yes | The URL of the checkout page to which the buyer will be redirected after he authorizes the order in Mondu Hosted Checkout Page. This callback will be triggered if the order gets the state decline state. The buyer should be able to choose a different payment method after the order was declined. Mondu will add a parameter order_uuid to the url upon the redirect. | https://checkout_page_url/shop.com |
| order.cancel_url | yes | The URL of the checkout page to which the buyer will be redirected after he cancels the order in Mondu Hosted Checkout Page and wants to go back to the shop. This callback will be triggered if the order gets the state cancel state. The buyer should be able to choose a different payment method after he canceled the order. Mondu will add a parameter order_uuid to the url upon the redirect. | https://checkout_page_url/shop.com |
| order.net_term | yes | Net terms apply to the invoice and direct debit payment methods. To be effective, they have to be configured in the Mondu account and specified in the commercial agreement. | 30, 60, 90 |
| order.payment_method | yes | Specify the payment method the buyer chose at checkout. | invoice, direct_debit, installment, installment_by_invoice, pay_now, billing_statement, |
| order.language | no | Determines the language shown to the buyer in Mondu Hosted Checkout Page and in the e-mail communication. Two-letter language code according to ISO_639-1. | DE, EN, NL, FR. |
| order.currency | yes | Currency code according to ISO_4217. | Mondu currently supports EUR, CHF or GBP. |
| order.external_reference_id | yes | Order ID in the shop system, which is included in the buyer communication. | a6e9f284-c4c9-4d3d-9146-982b227fd4ed, 1242842 ... |
| order.vendor_external_reference_id | no - merchant, yes - marketplace | Applicable only for single vendor marketplaces setup. Vendor ID in shop system. | 4fd1db9a-1b3a-4253-afc1-dd75c1b2ce47, 94824 ... |
| order.gross_amount_cents | no, but recommended | Total order amount in cents, including tax and after applying discounts.gross_amount_cents = net_amount_cents + total_tax_cents +shipping_cost - total_discount_cents, where: net_amount_cents = net_price_per_item_cents * quantity.This field overrides the total order amount calculated based on the information from the lines. | 37633 |
| order.total_discount_cents | no, but recommended | Total discount applied to the order in cents. | 3233 |
| order.additional_discount | no | ??? | ??? |
| order.additional_discount.discount_percentage | no | ??? | ??? |
| order.additional_discount.discount_term_days | no | ??? | ??? |
| order.buyer.email | yes | Buyer's email address that is valid. | |
| order.buyer.first_name | yes | Buyer's first name. | |
| order.buyer.last_name | yes | Buyer's last name. | |
| order.buyer.phone | no | Buyer's phone number. | +4815050028383 |
| order.buyer.legal_form | no | Legal form of the company. | Company legal forms |
| order.buyer.company_name | no, but recommended | Company name used by Mondu to identify the buyer. | |
| order.buyer.registration_id | no, but recommended | Company registration ID in the Commercial and Companies Register, Chamber of Commerce, Companies House or other relevant office. | Registration ID examples |
| order.buer.vat_number | no | VAT ID in buyer's country of origin. | DE346168540, NL864037417B01, GB444054023 |
| order.buyer.is_registered | no, but recommended | If the buyer is registered on the merchant's website set to true. | true, false |
| order.buyer.external_reference_id | no, but recommended | Buyer ID in shop system. | 0f33af9d-3682-4483-bb05-9ace3cfe8274, 63649 |
| order.buyer.account_created_at | no, but recommended | Timestamp indicating when the buyer account was created in the e-commerce or ERP platform. | 2025-06-09 15:29:58 |
| order.buyer.account_updated_at | no | Timestamp indicating when the buyer account was updated in the e-commerce or ERP platform. | 2025-06-09 15:29:58 |
| order.buyer.uuid | no | Buyer UUID is generated in Mondu system after the buyer successfully goes through the buyer onboarding process. It is sent to the merchant via buyer webhoook. It is required only for the payment method billing_statement. | c711c51e-c2a4-4409-b3ef-621023d8e5a8 |
| order.buyer.industry | no | It should contains descriptive name of the industry of the buyer's company. It is free text field. | Electronics, Fintech, Automotive, Retail |
| order.buyer.salutation | no | Buyers satutation title. | Mr., Mrs., Dr., |
| order.buyer.company_url | no | URL to the company's website. | https://www.shop.com |
| order.billing_address | yes | The buyer's billing address. | country_code:DE city: Berlin zip_code:10117 address_line1:Unter den Linden 16 |
| order.shipping_address | yes | The buyer's shipping address. It should be the same as the billing address. In case the shipping address is different from the billing address, the order will be either declined or sent to manual review. | country_code:DE city: Berlin zip_code:10117 address_line1:Unter den Linden address_line2:16 |
| order.billing(or shipping)_address.country_code | yes | Two-letter country code (ISO_3166 Alpha 2. | DE, AT, NL, GB |
| order.billing(or shipping)_address.city | yes | City, district, suburb, town, or village. | Berlin |
| order.billing(or shipping)_address.zip_code | yes | ZIP or postal code. | 10117 |
| order.billing(or shipping)_address.address_line1 | yes | Street, PO Box, or company name. | |
| order.billing(or shipping)_address.address_line2 | yes | Apartment, suite, unit, or building. | 16 |
| order.billing(or shipping)_address.state | no | State, county, province, or region. | Berlin |
| order.billing_configuration_uuid | no | Merchant can detrmine through these field which billing configuration should be applied to this order. This field applicable for the billing_statement payment method. If it is not sent, then the default billing configuraiton set by Mondu will be applied. | c711c51e-c2a4-4409-b3ef-621023d8e5a8 |
| order.merchant_informed_buyer | no | (Internal) We need to check, if this field can be removed. | True or False |
| order.lines[i] | yes | A line corresponds to a basket in an e-commerce platform. It represents a collection of products within an order.In a standard merchant configuration:
| Please see this article for more details. |
| order.lines[i].vendor_external_reference_id | no - merchant, yes - marketplace | Applicable only for multi vendor marketplaces setup. Vendor ID in shop system. | 4fd1db9a-1b3a-4253-afc1-dd75c1b2ce47, 94824 ... |
| order.lines[i].discount_cents | no, but recommended | Discount applied on this line (basket). | |
| order.lines[i].tax_cents | no | Tax applied to the particular line (basket). It is recommended to provide tax amount in line object, but it can be alternatively provided in the line item object. | |
| order.lines[i].shipping_price_cents | no,but recommended | Shipping price to be applied on this line (basket). | |
| order.lines[i].marketplace_fee_cents | no | ??? | ??? |
| order.lines[i].buyer_fee_cents | no | ??? | ??? |
| order.lines[i].line_items[j] | yes | A line_item corresponds to an individual product in the basket (line). | Keyboard, shampoo, |
| order.lines[i].line_items[j].external_reference_id | yes | Product ID in shop system. | 4eb22f77-dcd0-41c7-ae4b-6437dd86777f, 48444 |
| order.lines[i].line_items[j].title | yes | Human readable product name in shop system. | Iphone 17 Pro Max 512GB |
| order.lines[i].line_items[j].net_price_per_item_cents | yes | Net item price in cents. Tax is not included in this value. | 140619 |
| order.lines[i].line_items[j].quantity | yes | The quantit of the product in the basket. | 3 |
| order.lines[i].line_items[j].tax_cents | recommended | Tax applied on this line item. It is recommened to pass the tax amount in this object. | |
| order.lines[i].line_items[j].net_price_cents | no | Net price cents of all products of the sam type. Tax is not included in this value. | 421857 |
| order.lines[i].line_items[j].product_id | no | ??? | ??? |
| order.lines[i].line_items[j].product_sku | no | ??? | ??? |
| order.lines[i].line_items[j].variation_id | no | ??? | ??? |
| order.lines[i].line_items[j].item_type | no | ??? | ??? |
Fields specific for Create Async Order
| Field | Mandatory | Definition | Example |
|---|---|---|---|
| order.owner | yes for specific legal forms | Personal data of the owner or co-owner of the company. This field is required for the following legal forms:
| |
| order.owner.is_authorized | no, but recommended | If this owner is authorized to represent the business / make decisions, set to true. |
|
| order.buyer.legal_form_category | no | ??? | einzelunternehmen kapital_und_personen_gesellschaft offentliche_auftraggeber_einrichtung andere_gesellschaftsform |
| order.buyer.account_holder | yes for direct_debit and installments | Name of the account holder associated to the buyer from which Mondu the funds. It is either the name of the company holding the account or a name of the person. |
|
| order.buyer.iban | yes for direct_debit and installments | IBAN of the buyer's account from which Mondu withdraws the funds. | DE89 3704 0044 0532 0130 00 |
| order.number_of_installments | yes for installments | The number of intended installment (Integer). The API will validate this value against the account settings. | 3, 6, 12 |