Sign in
Refund

Create a refund

Creates a refund for the specified order. The order can be specified either by Ivy's internal orderId or by the referenceId provided by the merchant during checkout creation. If the refund should only be partial, you can specifiy this with the amount parameter.

post/api/service/refund/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

orderIdstring

The internal Ivy id of the order. Must be present in request body if referenceId is not provided

referenceIdstring

The external id set by the merchant during checkout creation. Required if orderId is not passed.

bankStatementReferencestring

An optional custom text that will be shown on the customer's payment reference. Input has to be maximum 16 alpha-numeric characters. If not provided, a default Ivy refund referenceId will be shown.

amountnumber required

Response

Creates a refund and returns the details of created refund

idstring required

The unique Refund id

amountnumber required

The amount of the refund in decimals.

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

Refund's currency.

status'initiated' | 'pending' | 'succeeded' | 'failed' required

The current status of this refund.

orderIdstring required

The id of the refunded order

transactionIdstring

The id of the transaction

Changes

Changed in 3 of the 48 revisions of this API.31

  • 84194dfc43b41See the full diff
    • ●

      added the new USD enum value to the currency response property for the response status 200

      response-property-enum-value-added

  • d617edaf95c01See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 59707ad8c8bb2See the full diff
    • ●

      the bankStatementReference request property's maxLength was set to 140

      request-property-max-length-set

    • ●

      the referenceId request property's maxLength was set to 200

      request-property-max-length-set