📘
The description of the attributes can be found in the API references and attribute definition pages:

Mondu Postman Collection

https://github.com/mondu-ai/postman-collection-for-integration#

Follow the Starting Integrating article for more details about the integration steps.

Payload Examples

Create Order (Standard Merchant Setup)

{
 //hosted checkout specific attributes
 "source": "hosted",
 "state_flow":"authorization_flow",
 "success_url": "http://shopdomain.com/success",
 "cancel_url": "http://shopdomain.com/cancel",
 "declined_url": "http://shopdomain.com/declined",
 "language": "en", //en|de|nl|fr

 //order specific attibutes
 "payment_method": "invoice",  //invoice|installment_by_invoice|direct_debit|installments|billing_statement
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 "net_term": 30, // 14|30|60|90
 

 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z"
   
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   //"uuid": "3f228358-a916-436d-b35c-9c9ac869d155"

 },

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  //product related attriburtes
 "gross_amount_cents": 1875,

 "lines": [
   {
     "shipping_price_cents": 100,
     "discount_cents": 10,
     "tax_cents": 285,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 190 //optional if cannot be provided in lines
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
 //hosted checkout specific attributes
 "source": "hosted",
 "state_flow":"authorization_flow",
 "success_url": "http://shopdomain.com/success",
 "cancel_url": "http://shopdomain.com/cancel",
 "declined_url": "http://shopdomain.com/declined",
 "language": "en", //en|de|nl|fr

 //order specific attibutes
 "payment_method": "billing_statement",  //invoice|installment_by_invoice|direct_debit|installments|billing_statement
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 
 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z",
   
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   "uuid": "3f228358-a916-436d-b35c-9c9ac869d155"

 },

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  //product related attriburtes
 "gross_amount_cents": 1885,

"lines": [
   {
     "shipping_price_cents": 100,
     "discount_cents": 10,
     "tax_cents": 285,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 190 //optional if cannot be provided in lines
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
  "order": {
    "uuid": "12345667-890a-bcde-f123-34567890abcd",
    "state": "created",
    "external_reference_id": "your-buyer-id-123-456"
  }
}

Create Order (Marketplace Setup - Multi-Vendor & Single-Vendor)

{
 //hosted checkout specific attributes
 "source": "hosted",
 "state_flow":"authorization_flow",
 "success_url": "http://shopdomain.com/success",
 "cancel_url": "http://shopdomain.com/cancel",
 "declined_url": "http://shopdomain.com/declined",
 "language": "en", //en|de|nl|fr

 //order specific attibutes
 "payment_method": "invoice",  //invoice|installment_by_invoice|direct_debit|installments|billing_statement
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 "net_term": 30, //14|30|60|90
 

 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z"
   
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   //"uuid": "3f228358-a916-436d-b35c-9c9ac869d155"

 },

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  //product related attriburtes
 "gross_amount_cents": 1970,
 
 "lines": [
   {
     "vendor_external_reference_id": "your-vendor-id-1", // vendor ID of first vendor
     "shipping_price_cents": 100,
     "discount_cents": 10,
      "tax_cents": 190,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 190 //optional if cannot be provided in lines
       }
     ]
   },
   {
     "vendor_external_reference_id": "your-vendor-id-2", // vendor ID of first vendor
     "shipping_price_cents": 100,
     "discount_cents": 5,  
     "tax_cents": 95,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
 //hosted checkout specific attributes
 "source": "hosted",
 "state_flow":"authorization_flow",
 "success_url": "http://shopdomain.com/success",
 "cancel_url": "http://shopdomain.com/cancel",
 "declined_url": "http://shopdomain.com/declined",
 "language": "en", //en|de|nl|fr

 //order specific attibutes
 "payment_method": "invoice",  //invoice|installment_by_invoice|direct_debit|installments|billing_statement
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 "net_term": 30, //14|30|60|90
 
 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z"
   
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   //"uuid": "3f228358-a916-436d-b35c-9c9ac869d155"
 },

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  //product related attriburtes
 "gross_amount_cents": 1870,
 "total_discount_cents": 15,
 "vendor_external_reference_id": "your-vendor-id", // vendor ID 
 "lines": [
   {
    "shipping_price_cents": 100, 
    "discount_cents":10,
		"tax_cents": 190,

       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 190//optional if cannot be provided in lines
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95//optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
  "order": {
    "uuid": "12345667-890a-bcde-f123-34567890abcd",
    "state": "created",
    "external_reference_id": "your-buyer-id-123-456"
  }
}

Create Async Order

{
 "language": "en", //en|de|nl|fr

 //order specific attibutes
 "payment_method": "invoice",  //invoice|installment_by_invoice|direct_debit|installments|billing_statement
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 "net_term": 30, // 14|30|60|90
 
 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z"
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   //"uuid": "3f228358-a916-436d-b35c-9c9ac869d155"

 },
  
  "owners": [
    {
      "first_name": "Michael",
      "last_name": "Mustermensch"
    }
  ],

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  //product related attriburtes
 "gross_amount_cents": 1875,
 "lines": [
   {
     "shipping_price_cents": 100, 
     "discount_cents": 10,
     "tax_cents":285,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service",
         //"tax_cents": 190 //optional if cannot be provided in lines
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
  "order": {
    "uuid": "12345667-890a-bcde-f123-34567890abcd",
    "state": "processing",
    "external_reference_id": "your-buyer-id-123-456"
  }
}

Adjust Order

{
   "currency": "EUR",
   "amount": {
   "gross_amount_cents": 2286
  },

"lines": [
   {
    "shipping_price_cents": 100,
     "discount_cents":15,
      "tax_cents": 351,
       "line_items": [
       {
         "quantity": 13,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 247 //optional if cannot be provided in lines
       },
       {
         "quantity": 11,
         "external_reference_id": "your-product-id-987-654",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 104 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
    "order": {
        "uuid": "d4a6f5cd-d4ff-422e-b1af-6f4e8f59be8b",
        "state": "confirmed",
        "external_reference_id": "your-order-id-12b1a0c9-c9fd-4abe-8adf-04b2be252eab"
    }
}

{
  “errors”: [
    {
      “details”: “can not update order in current state”,
      “name”: “”
    }
  ],
  “status”: 422
}

{
    "errors": [
        {
            "details": "must be a number",
            "name": "amount.gross_amount_cents"
        }
    ],
    "status": 422
}

Create Factoring

{
 //order specific attibutes
 "payment_method": "invoice",  //invoice|installment_by_invoice|direct_debit|installments
 "currency": "EUR",
 "external_reference_id": "your-order-id-123-456",
 "net_term": 30, // 14|30|60|90
 

 "buyer": {
   //mandatory attributes
   "email": "accepted.max.doe@example.com", 
   //accepted.jon.max@example.com sets the order to status confirmed
   //pending.jon.max@example.com sets the order to status pending
   "first_name": "Max",
   "last_name": "Mustermann",
 
   //recommended to optimise ux in the mondu hosted checkout page
   "external_reference_id": "your-buyer-id-123-456",
   "company_name": "Mondu GmbH",
   "legal_form":"GmbH",
   "registration_id": "HRB232626B", // company registration id
   "is_registered": true, // true if the company is registered

   //recommended to help mondu create better stats on buyer 
   "account_created_at": "2023-08-22T15:25:56.265Z",
   "account_updated_at": "2024-08-22T15:25:56.265Z"
   
   //If buyer is onboarded add the buyer uuid sent via buyer webhook
   //"uuid": "3f228358-a916-436d-b35c-9c9ac869d155"

 },

 "billing_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },

 "shipping_address": {
   "country_code": "DE",
   "city": "Berlin",
   "zip_code": "10117",
   "address_line1": "Unter den Linden 16",
   "address_line2": "",
   "state": "Berlin"
 },
  "invoice_issued_at": "2025-06-10 15:39:54",
  "invoice_external_reference_id": "your-invoice-id-123-456",
  "invoice_url": "https://cdn.shop.com/media/invoices/59466/invoice-id-123-456.pdf",
  //product related attriburtes
 "gross_amount_cents": 1875,
 "lines": [
   {
     "shipping_price_cents": 100,
     "discount_cents": 10,
     "tax_cents": 285,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456",
         "title": "Product A",
         "net_price_per_item_cents": 100,
         "item_type": "product|service"//,
         //"tax_cents": 190 //optional if cannot be provided in lines
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654",
         "title": "Product B",
         "net_price_per_item_cents": 50,
         "item_type": "product|service"//,
         //"tax_cents": 95 //optional if cannot be provided in lines
       }
     ]
   }
 ]
}

{
    "factoring_uuid": "3189e928-f39e-4f11-8035-223607982840",
    "state": "processing"
}

Create Invoice

{
  "source": "api",
  "issued_at": "2023-05-11T10:09:57.533Z",
  "invoice_url": "https://cdn.shop.com/media/invoices/59466/your-invoice-id-123-456.pdf",
  "external_reference_id": "your-invoice-id-{{$randomUUID}}",
  "gross_amount_cents": 1875,
   "shipping_price_cents": 100,
   "discount_cents":10,
   "tax_cents": 285,
   "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456"
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654"
       }
     ]
}

curl --request POST \
  --url https://api.demo.mondu.ai/api/v1/orders/<<order-uuid>>/invoices \
  --header 'Api-Token: <api-key>>' \
  --header 'content-type: multipart/form-data' \
  --form source=api \
  --form issued_at=2023-05-11T10:09:57.533Z \
  --form external_reference_id=your-invoice-id-123-456 \
  --form gross_amount_cents=1875 \
  --form 'lines[][shipping_price_cents]=100'
  --form 'lines[][discount_cents]=10'
  --form 'lines[][tax_cents]=285'
  --form 'line_items[][quantity]=10' \
  --form 'line_items[][external_reference_id]=your-product-id-123-456' \
  --form 'line_items[][quantity]=10' \
  --form 'line_items[][external_reference_id]=your-product-id-987-654' \
  --form file=@file

{
    "invoice": {
        "state": "created",
        "uuid": "b498bb1b-17d7-5ae5-bbcf-9410e11c9f5b",
        "external_reference_id": "your-invoice-id-123-456"
    }
}

Create Credit Note

{
  "source": "api",
  "issued_at": "2023-05-11T10:09:57.533Z",
  "invoice_url": "https://cdn.shop.com/media/invoices/59466/your-invoice-id-123-456.pdf",
  "external_reference_id": "your-invoice-id-{{$randomUUID}}",
  "gross_amount_cents": 1875,
   "shipping_price_cents": 100,
   "discount_cents":10,
   "tax_cents": 285,
       "line_items": [
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-123-456"
       },
       {
         "quantity": 10,
         "external_reference_id": "your-product-id-987-654"
       }
     ]
}

curl --request POST \
  --url https://api.demo.mondu.ai/api/v1/orders/<<order-uuid>>/invoices \
  --header 'Api-Token: <api-key>>' \
  --header 'content-type: multipart/form-data' \
  --form source=api \
  --form issued_at=2023-05-11T10:09:57.533Z \
  --form external_reference_id=your-credit-note-id-123-456 \
  --form gross_amount_cents=1875 \
  --form 'lines[][shipping_price_cents]=100'
  --form 'lines[][tax_cents]=285'
  --form 'line_items[][quantity]=10' \
  --form 'line_items[][external_reference_id]=your-product-id-123-456' \
  --form 'line_items[][quantity]=10' \
  --form 'line_items[][external_reference_id]=your-product-id-987-654' \
  --form file=@file

{
    "invoice": {
        "state": "created",
        "uuid": "b498bb1b-17d7-5ae5-bbcf-9410e11c9f5b",
        "external_reference_id": "your-invoice-id-123-456"
    }
}

Hosted Buyer Onboarding / Digital Trade Account

{
  //MANDATORY PARAMETERS
  "external_reference_id": "your-buyer-id-123-456",
  "redirect_urls": {
        "success_url": "http://yourshop.com/success",
        "cancel_url": "http://yourshop.com/cancel",
        "declined_url": "http://yourshop.com/declined"
    },
  	//OPTIONAL PARAMETERS
    "applicant": {
        "first_name": "Max",
        "last_name": "Musterman",
        "email": "accepted.good.randomstring@example.com",// Buyer approved; all subsequent orders auto-approved
        //"email": "pending.pending-brc.randomstring@example.com",// Buyer set to pending; all subsequent orders set to pending
        //"email": "declined@example.com",// Buyer declined; all subsequent orders auto-declined
        //https://docs.mondu.ai/v0.7/docs/start-integrating#32-buyer-onboarding-testing-digital-trade-account
        "phone": "030123456"
    },
    "company_details": {
    "registration_address": {
      "country_code": "DE",
      "state": "Berlin",
      "city": "Berlin",
      "zip_code": "10117",
      "address_line1": "Unter den Linden 16"
    },
    "legal_form_type": "registered_company",
    "name": "Mondu GmbH",
    "company_registration_id": "HRB 232626 B"
  }
}

{
  "hosted_page_url": "https://onboarding.demo.mondu.ai?session_uuid=05b69bcf-4d8e-4519-b186-d64e7948e788&session_token=919497f5-4b52-45eb-abb3-2f795ff61ada"
}