--- title: "Create an Order" method: POST path: "/api/service/order/create" tags: ["Order"] --- # Create an Order `POST /api/service/order/create` Create a new order. By creating a new order, you will create a new settlement destination which you can use to settle expected incoming payments efficiently. After creating the order, Ivy provides you with a destination for the expected incoming payment. As soon as a payment with the same details arrives, Ivy will update the status of the order. ## Headers - `Idempotency-Key` string ## Request body - CreateOrderDto - `amount` number, required — The total amount of the order - `currency` 'EUR' | 'USD' | 'GBP' | 'PLN' | 'SEK' | 'DKK', required — The currency code of the order - `referenceId` string, required — The merchant's unique reference ID for the order - `expiresAt` string — Optional expiration timestamp in seconds - `customer` object — The customer of the merchant. - `id` string, uuid — The Ivy id of the customer. - `email` string, email — The email of the customer. - `phone` string — The phone number of the customer in international format (e.g., +491631234567) - `subaccountId` string, uuid — The subaccount id of the merchant. ## Response `200` Order created successfully - CreateOrderResponseDto - `id` string, required — The unique id for the order. - `merchantId` string, required - `payerFinancialAddress` object — The financial address of the payer associated with the order. Only available after successful PIS flow. - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba', required - `aba` object - `accountHolderName` string - `routingNumber` string, required - `accountNumber` string, required - `iban` object - `accountHolderName` string - `iban` string, required - `bic` string - `sortCode` object - `accountHolderName` string - `sortCode` string, required - `accountNumber` string, required - `bankCode` object - `accountHolderName` string - `code` string, required - `accountNumber` string, required - `bban` object - `accountHolderName` string - `bban` string, required - `bic` string - `wallet` object - `address` string, required — The blockchain wallet address - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network - `appId` string, required — The unique id for the merchantApp which initiated the order. - `merchantAppId` string, required — Same as appId - `shopName` string, required — The legal name of the merchant which initiated the order. - `referenceId` string, required — A unique id for the order which can be set when creating the checkoutSession. - `displayId` string — The customer-facing id of the order. - `offsetProject` string — The project related to the order. - `metadata` object — Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. - `category` string — The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide. - `co2Grams` number - `applicationFeeAmount` number, required — The amount of application fee collected with the order. - `price` object, required — The price object. All values in decimals, e.g. 0.13 for 13 cents. - `total` number, required - `currency` 'EUR' | 'USD' | 'GBP' | 'PLN' | 'SEK' | 'DKK', required - `subTotal` number - `shipping` number - `totalNet` number - `vat` number - `lineItems` object[] — The list of line items sold with the order. - `name` string, required — Customer-facing name of the line item. - `referenceId` string — An internal unique id stored to this line item. - `singleNet` number, required - `singleVat` number, required - `amount` number, required — Accumulated cost in decimals. For example, for a lineItem with total price 3.00 and quantity 4, amount would be equal to 12.00. - `quantity` number — Quantity of this lineItem. - `image` string — An image of the line item. Valid URLs are accepted only. - `category` '5045' | '5065' | '5094' | '5192' | '5193' | '5499' | '5655' | '5691' | '5712' | '5722' | '5812' | '5814' | '5912' | '5977' | '5999' | '7629' - `EAN` string - `co2Grams` number - `shopLogo` string - `guest` boolean - `climateActionMode` object - `type` 'transaction' | 'amount', required - `amount` number, required - `impactOffsetProjects` unknown[] - unknown - `billingAddress` object - `firstName` string - `lastName` string - `line1` string, required - `line2` string - `region` string - `city` string, required - `zipCode` string, required - `country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK', required - `shippingAddress` object - `firstName` string - `lastName` string - `line1` string, required - `line2` string - `region` string - `city` string, required - `zipCode` string, required - `country` 'AF' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IL' | 'IT' | 'JM' | 'JP' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MP' | 'MK' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'SH' | 'KN' | 'LC' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'SC' | 'SL' | 'SG' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SZ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'AX' | 'BQ' | 'CW' | 'GG' | 'IM' | 'JE' | 'ME' | 'BL' | 'MF' | 'RS' | 'SX' | 'SS' | 'XK', required - `paymentStatus` 'not_settled' | 'failed' | 'canceled' | 'processing' | 'requires_action' | 'succeeded' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'disputed' — Deprecated. The status of the payment. - `status` 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing', required — The status of the order. As soon as this value is 'paid', you can ship the order. - `refunds` object[] — All partial and total refunds of this order. - `id` string, required — The unique id of this refund request. - `description` string — The description of the refund. - `referenceId` string, required — The unique id of this refund request. This can be set when requesting the refund. - `transactionId` string — The unique id of the transaction. - `amount` number, required — The amount of the refund in decimals. - `status` 'pending' | 'succeeded' | 'failed' | 'requires_action' | 'partially_refunded', required — The current status of this refund. - `createdAt` unknown, required - `updatedAt` unknown, required - `refundAmount` number — The total amount in the currency of all successful refunds for this order - `createdAt` unknown, required - `updatedAt` unknown, required - `shopperEmail` string — Deprecated. The email of the customer who completed the order. - `shopper` object — Information about the customer who finished the order. - `email` string - `phoneNumber` string - `trees` number - `merchantFinancialAddress` object — The financial address of the merchant associated with the order. Only available when requested via order/details and therefore requires authentication. - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba', required - `iban` object - `accountHolderName` string, required - `iban` string, required - `bic` string - `aba` object - `accountHolderName` string, required - `routingNumber` string, required - `accountNumber` string, required - `sortCode` object - `accountHolderName` string, required - `sortCode` string, required - `accountNumber` string, required - `bankCode` object - `accountHolderName` string, required - `code` string, required - `accountNumber` string, required - `bban` object - `accountHolderName` string, required - `bban` string, required - `bic` string - `wallet` object - `address` string, required — The blockchain wallet address - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network - `paymentReference` string - `bankStatementReference` string — The reference that will be shown on the bank statement of the customer. Only available after a successful DirectDebit initiation. - `destination` object — The destination bank account and statement reference for the order. - `bankAccount` object, required - `type` 'iban' | 'sort_code' | 'bank_code' | 'bban' | 'wallet' | 'aba', required - `iban` object - `accountHolderName` string, required - `iban` string, required - `bic` string - `aba` object - `accountHolderName` string, required - `routingNumber` string, required - `accountNumber` string, required - `sortCode` object - `accountHolderName` string, required - `sortCode` string, required - `accountNumber` string, required - `bankCode` object - `accountHolderName` string, required - `code` string, required - `accountNumber` string, required - `bban` object - `accountHolderName` string, required - `bban` string, required - `bic` string - `wallet` object - `address` string, required — The blockchain wallet address - `blockchain` 'BTC' | 'BTC-TESTNET4' | 'ETH' | 'ETH-SEPOLIA' | 'SOL' | 'SOL-DEVNET' | 'MATIC' | 'MATIC-AMOY', required — The blockchain network - `paymentReference` string - `bankStatementReference` string, required — The bank statement reference of the payment for the order. This is the reference that will be visible on the bank statement. - `paymentMethodType` 'customer_balance' | 'manual_bank_transfer' - `statusHistoryList` object[] - `previousStatus` 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing', nullable - `currentStatus` 'failed' | 'canceled' | 'processing' | 'waiting_for_payment' | 'waiting_for_bank_confirmation' | 'paid' | 'in_refund' | 'refunded' | 'refund_failed' | 'partially_refunded' | 'in_dispute' | 'disputed' | 'refused' | 'finalizing', required - `reason` 'ORDER_CREATED' | 'CHECKOUT_SESSION_ABORTED' | 'PAYMENT_SUCCEEDED' | 'PAYMENT_INITIATED' | 'ORDER_CANCELED' | 'ORDER_EXPIRED_BY_MERCHANT' | 'ORDER_REFUND_INITIATED' | 'ORDER_REFUNDED' | 'REFUND_CHARGE_SUCCEEDED' | 'REFUND_UPDATED' | 'CHECKOUT_COMPLETED' | 'USER_CONFIRMED' | 'PIS_PAYMENT_INITIATED' | 'PIS_PAYMENT_UPDATED' | 'PIS_PAYMENT_SUCCEEDED' | 'PAYMENT_NOT_SETTLED' | 'PAYMENT_INITIATION_FAILED' | 'PAYMENT_CANCELED' | 'PAYMENT_FAILED' | 'CHECKOUT_SESSION_CREATED' | 'EXPIRED_CHECKOUT_SESSION_ABORTED' | 'DISPUTE' | 'PENDING_PAYMENT_ATTEMPTS_FOUND' | 'AML_FREEZE' | 'AML_APPROVE' | 'AML_REJECT' | 'AML_SEIZE' | 'MANUAL_FREEZE' | 'MANUAL_UNFREEZE' | 'ORDER_MANUALLY_REOPENED' | 'ORDER_FINALIZATION_STARTED', required - `createdAt` unknown, required - `updatedAt` unknown, required - `subaccountId` string — The subaccount id of the merchant. - `subaccountLegalName` string - `instantPaymentScheme` boolean, required - `statusClassification` object - `primary` 'payment_authorisation_failed' | 'payment_execution_failed' | 'payment_abandoned', required - `secondary` 'timeout' | 'wrong_credentials' | 'incorrect_2fa_response' | 'payment_rejected' | 'insufficient_funds' | 'cancelled' | 'connection_to_bank_failed' | 'international_transfer_blocked' | 'international_transfer_limit_exceeded' | 'user_blocked' | 'bank_error' | 'instant_transfers_not_enabled' | 'no_active_tan_methods_available' | 'account_limit_exceeded' | 'bank_under_maintenance' | 'pin_blocked' | 'payment_not_settled' | 'unsupported_bank_account' | 'online_banking_login_required' | 'deutsche_bank_psu_migration' | 'out_of_operational_hours' - `paymentMode` 'direct' | 'settlement' — The payment mode of the order. Can be either settlement or direct. - `customerId` string — The unique identifier of the customer who placed the order. - `bankId` string — The unique identifier of the customer's bank. - `transactionId` string — The unique id of the transaction. --- [API](https://skmtc.net/augustus/apis/ivy-api.md) · [All operations](https://skmtc.net/augustus/apis/ivy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/augustus/ivy-api/revisions/c3055fc06ca3/schema)