Update an order
Update certain fields of the specified order.
Authorizations
Body
The customer-facing name of the shop.
The order status. This status symbolises the state of the user's payment attempt. See the guide for more information.
failed
, canceled
, processing
, in_handshake
, waiting_for_payment
, paid
, in_refund
, refunded
, refund_failed
, partially_refunded
, in_dispute
, disputed
, refused
The customer-facing id of the order. This id will also be shown next to the orders in the Ivy Dashboard.
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.
200
Response
The Ivy unique identifier for the order.
The unique identifier for the merchant which initiated the order / payment attempt.
The unique identifier for the merchantApp which initiated the order / payment attempt.
Deprecated in favor of appId
.
The name of the merchant which initiated the order.
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.
200
The Ivy fee for the payment.
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.
The order status. This status symbolises the state of the user's payment attempt. See the guide for more information.
failed
, canceled
, processing
, in_handshake
, waiting_for_payment
, paid
, in_refund
, refunded
, refund_failed
, partially_refunded
, in_dispute
, disputed
, refused
The source bank account where the money is send from.
Deprecated in favor of shopper.email
. The email of the user if collected in the Checkout.
The shopper object. Contains information collected from the user during the Checkout.
The billing address of the user. Required when handshake=true.
The shipping address of the user. This is only collected in express Checkouts.
Any data which will be stored and returned for this checkout session and corresponding order. See here for more info.
The line items of the Checkout.
The logo of the shop provided as a URL.
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.
white_label
, sustainable
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.
Only valid for sustainable incentive mode. The social / sustainable projects available to the user during Checkout.
The selected shipping method by the user. Can either be selected during an express Checkout Session or passed during Checkout Session creation.
Deprecated in favor of status
. Do not use this field to trigger actions in your system.
failed
, canceled
, processing
, requires_action
, succeeded
, in_refund
, refunded
, refund_failed
, partially_refunded
, not_settled
, disputed
The list of refunds connected to this order.
The total amount in the currency of all successful refunds for this order
Only valid for sustainable incentive mode. The social / sustainability project chosen by the user during Checkout.
The customer facing id. This id is displayed to the user during the checkout and in the merchant dashboard.
200
The destination bank account where the money will be sent to.
The bank statement reference of the payment for the order. This is the reference that will be visible on the bank statement.
List of status history items for the order, used for logging every update on status.
sepa_debit
, customer_balance
The subaccount id of the order.
The legal name of the subaccount
The payment mode of the order. Can be either 'settlement' or 'direct'.
settlement
, direct
The unique identifier of the customer who placed the order.