Sign in
Order

Retrieve an Order

Retrieve details of an order. You can retrieve the order by passing either the internal Ivy order id or the referenceId you specified when creating a Checkout Session to the id field.

post/api/service/order/details

Request body

idstring required

You can put in either the Ivy id OR the referenceId of the order

Response

Order details retrieved 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:DetailsOrderResponseDto:properties:createdAt","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:DetailsOrderResponseDto: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.

Changes

Changed in 13 of the 52 revisions of this API.83110

  • 5bf687d3cbee1See the full diff
    • ●

      added the new AML_SEIZE enum value to the // response property for the response status

      response-property-enum-value-added

  • 103711f8bc3a7See the full diff
    • ●

      added the new AML_REJECT enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

  • 3ed3cb51802c7See the full diff
    • ●

      added the new AML_REJECT enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the /// response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new BTC-TESTNET4 enum value to the // response property for the response status

      response-property-enum-value-added

  • f133fdf6c9bd3See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 84194dfc43b44See the full diff
    • ●

      added the new USD enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new aba enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new aba enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new aba enum value to the / response property for the response status

      response-property-enum-value-added

  • 917638bf93491See the full diff
    • ●

      added the new AML_APPROVE enum value to the // response property for the response status

      response-property-enum-value-added

  • 59cef194e1d11See the full diff
    • ●

      added the new USER_CONFIRMED enum value to the // response property for the response status

      response-property-enum-value-added

  • d617edaf95c03See the full diff
    • ●

      added the new waiting_for_bank_confirmation enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new waiting_for_bank_confirmation enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new waiting_for_bank_confirmation enum value to the // response property for the response status

      response-property-enum-value-added

  • 999c91fe685d3See the full diff
    • ○

      added the required property /// to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • 67331c93ebb12See the full diff
    • ●

      added the new deutsche_bank_psu_migration enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new out_of_operational_hours enum value to the / response property for the response status

      response-property-enum-value-added