POST
/
api
/
service
/
order
/
update

Authorizations

X-Ivy-Api-Key
string
header
required

Body

application/json
id
string
required
shopName
string

The customer-facing name of the shop.

status
enum<string>

The order status. This status symbolises the state of the user's payment attempt. See the guide for more information.

Available options:
failed,
canceled,
processing,
in_handshake,
waiting_for_payment,
paid,
in_refund,
refunded,
refund_failed,
partially_refunded,
in_dispute,
disputed,
refused
displayId
string

The customer-facing id of the order. This id will also be shown next to the orders in the Ivy Dashboard.

referenceId
string

An internal reference id which will be stored with the checkout & corresponding order. Needs to be unique per shop per order and can be up to 200 characters. We recommend to use your internal order id here.

Maximum length: 200

Response

200 - application/json
id
string
required

The Ivy unique identifier for the order.

merchantId
string
required

The unique identifier for the merchant which initiated the order / payment attempt.

appId
string
requireddeprecated

The unique identifier for the merchantApp which initiated the order / payment attempt.

merchantAppId
string
requireddeprecated

Deprecated in favor of appId.

shopName
string
required

The name of the merchant which initiated the order.

referenceId
string
required

An internal reference id which will be stored with the checkout & corresponding order. Needs to be unique per shop per order and can be up to 200 characters.

Maximum length: 200
applicationFeeAmount
number
required

The Ivy fee for the payment.

price
object
required

The amount to be paid by the user. The amounts is in decimals, i.e. 10.23 represents EUR 10.23. Any amount of decimal places can be provided on initialization, but the actual transfer amount is rounded to 2 decimal places, as this is the format accepted by most banks.

status
enum<string>
required

The order status. This status symbolises the state of the user's payment attempt. See the guide for more information.

Available options:
failed,
canceled,
processing,
in_handshake,
waiting_for_payment,
paid,
in_refund,
refunded,
refund_failed,
partially_refunded,
in_dispute,
disputed,
refused
createdAt
string
required
updatedAt
string
required
instantPaymentScheme
boolean
required
payerFinancialAddress
object

The source bank account where the money is send from.

shopperEmail
string
deprecated

Deprecated in favor of shopper.email. The email of the user if collected in the Checkout.

shopper
object

The shopper object. Contains information collected from the user during the Checkout.

billingAddress
object

The billing address of the user. Required when handshake=true.

shippingAddress
object

The shipping address of the user. This is only collected in express Checkouts.

metadata
object

Any data which will be stored and returned for this checkout session and corresponding order. See here for more info.

category
string

The merchant category code or MCC.

co2Grams
number
deprecated
trees
number
deprecated
lineItems
object[]

The line items of the Checkout.

The logo of the shop provided as a URL.

incentiveMode
enum<string>
default:
white_label

The incentive mode of the checkout session. For any use-case apart from e-commerce, please use white_label as the value. If set to white_label, the checkout session will be white labeled. If set to sustainable, the checkout session will contain sustainable incentives for users.

Available options:
white_label,
sustainable
guest
boolean

False by default. If set to true, customers skip email input and jump directly to their bank login. For express Checkout Sessions this is always false.

climateActionMode
object
impactOffsetProjects
string[]

Only valid for sustainable incentive mode. The social / sustainable projects available to the user during Checkout.

shippingMethod
object

The selected shipping method by the user. Can either be selected during an express Checkout Session or passed during Checkout Session creation.

paymentStatus
enum<string>

Deprecated in favor of status. Do not use this field to trigger actions in your system.

Available options:
failed,
canceled,
processing,
requires_action,
succeeded,
in_refund,
refunded,
refund_failed,
partially_refunded,
not_settled,
disputed
refunds
object[]

The list of refunds connected to this order.

refundAmount
number

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

offsetProject
string

Only valid for sustainable incentive mode. The social / sustainability project chosen by the user during Checkout.

displayId
string

The customer facing id. This id is displayed to the user during the checkout and in the merchant dashboard.

Maximum length: 200
merchantFinancialAddress
object

The destination bank account where the money will be sent to.

bankStatementReference
string

The bank statement reference of the payment for the order. This is the reference that will be visible on the bank statement.

statusHistoryList
object[]

List of status history items for the order, used for logging every update on status.

paymentMethodType
enum<string>
Available options:
sepa_debit,
customer_balance
mandate
object
subaccountId
string

The subaccount id of the order.

statusClassification
object

The legal name of the subaccount

paymentMode
enum<string>

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

Available options:
settlement,
direct
customerId
string

The unique identifier of the customer who placed the order.