Sign in

v47

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-013871777.1 KB
Order

Create an Order

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.

post/api/service/order/create

Headers

Idempotency-Keystring

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Request body

amountnumber required

The total amount of the order

currency'EUR' | 'USD' | 'GBP' | 'PLN' | 'SEK' | 'DKK' required

The currency code of the order

referenceIdstring required

The merchant's unique reference ID for the order

expiresAtstring

Optional expiration timestamp in seconds

subaccountIdstring uuid

The subaccount id of the merchant.

Response

Order created successfully

idstring required

The unique id for the order.

merchantIdstring required
appIdstring required

The unique id for the merchantApp which initiated the order.

merchantAppIdstring required

Same as appId

shopNamestring required

The legal name of the merchant which initiated the order.

referenceIdstring required

A unique id for the order which can be set when creating the checkoutSession.

displayIdstring

The customer-facing id of the order.

offsetProjectstring

The project related to the order.

metadataobject

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.

categorystring

The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.

co2Gramsnumber
applicationFeeAmountnumber required

The amount of application fee collected with the order.

shopLogostring
guestboolean
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.

refundAmountnumber

The total amount in the currency of all successful refunds for this order

{"stackTrail":"components:schemas:CreateOrderResponseDto:properties:createdAt","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:CreateOrderResponseDto:properties:updatedAt","oasType":"schema","type":"unknown"}
shopperEmailstring

Deprecated. The email of the customer who completed the order.

treesnumber
bankStatementReferencestring

The reference that will be shown on the bank statement of the customer. Only available after a successful DirectDebit initiation.

paymentMethodType'customer_balance' | 'manual_bank_transfer'
subaccountIdstring

The subaccount id of the merchant.

subaccountLegalNamestring
instantPaymentSchemeboolean required
paymentMode'direct' | 'settlement'

The payment mode of the order. Can be either settlement or direct.

customerIdstring

The unique identifier of the customer who placed the order.

bankIdstring

The unique identifier of the customer's bank.

transactionIdstring

The unique id of the transaction.