Skip to content
Navigation

Records a refund of an order, optionally revoking what it granted.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/orders/{order}/refunds

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • order
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON required

  • settlement
    object
    required
    • id
      string
      required
      maxLength: 512 · minLength: 1
  • amount
    integer
    required
    minimum: 1
  • reason
    optional

    One of the following:

    • string
    • null
  • processor_ref
    optional

    One of the following:

    • string
    • null
  • allocations
    optional
    array of
    object
    • order_item
      object
      required
      • id
        string
        required
        maxLength: 512 · minLength: 1
    • amount
      integer
      required
      minimum: 0
    • guests
      optional
      array of
      object

      The guest tickets of an event's line this refund ends, each giving its seat back.

      • id
        string
        required
        maxLength: 512 · minLength: 1

Returns

201

Records a refund of an order, optionally revoking what it granted.

JSON
  • allocations
    array of
    object
    required
    • currency
      string
      required
    • exponent
      required

      One of the following:

      • number
      • null
    • refund_id
      string
      required
    • order_item_id
      string
      required
    • amount
      required

      One of the following:

      • number
      • null
  • id
    string
    required
  • settlement_id
    string
    required
  • order_id
    string
    required
  • processor_ref
    required

    One of the following:

    • string
    • null
  • amount
    required

    One of the following:

    • number
    • null
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • reason
    required

    One of the following:

    • string
    • null
  • occurred_at
    required

    One of the following:

    • string
    • null
  • recorded_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close