Skip to content
Navigation

Tries a canceled event's failed refund again.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/event_refunds/{refund}/retry

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • refund
    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 optional

Returns

200

Tries a canceled event's failed refund again.

JSON
  • id
    string
    required
  • product_id
    string
    required
  • customer_id
    string
    required
  • order_id
    string
    required
  • settlement_id
    string
    required
  • status
    string
    required

    pending while owed, refunded once given back, failed for the seller to retry, manual for a sale paid outside the store, which the seller refunds.

  • amount
    required

    One of the following:

    • number
    • null
  • currency
    string
    required
  • exponent
    required

    One of the following:

    • number
    • null
  • failure
    required

    Why the last try failed: processor_refused, account_gone, processor_failed, processor_unavailable, nothing_left or order_unreconciled; null unless failed.

    One of the following:

    • string
    • null
  • refund_id
    required

    The refund recorded on the order once it landed.

    One of the following:

    • string
    • null
  • processor_ref
    required

    One of the following:

    • string
    • null
  • refunded_at
    required

    One of the following:

    • string
    • null
  • created_at
    string
    required
  • customer
    required

    Who it gives back to, erased once their details are wiped.

    One of the following:

    • object
    • 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