Contents x
    Refund an order
    • 22 Nov 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Refund an order

    • Updated on 22 Nov 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Post
    /orders/v1/orders/{orderId}/_refund

    Refund a specific order.

    Security
    HTTP
    Type bearer
    Path parameters
    orderId
    stringRequired
    Min length1
    Body parameters
    Expand All
    object
    monetary
    object
    refundAmount
    number Required
    Minimum0
    transactionId
    string Required
    currency
    string Required
    credit
    object
    creditAmount
    number Required
    Minimum1
    subscriptionId
    string Required
    customerId
    string Required
    contractVersion
    string Required
    Valid values[ "v2", "v3", "v4" ]
    Responses
    200

    Order Refunded

    Expand All
    object
    data
    object
    meta
    object

    Additional information about the resource.

    property*
    400

    Bad Request

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    401

    Unauthorized

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    403

    Forbidden

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    409

    Order already refunded/amount invalid

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    429

    Too Many Requests

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    500

    Internal Server Error

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    502

    Payment Gateway Error

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    503

    Service Unavailable

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    504

    Gateway Timeout

    Expand All
    object
    error
    Array of object

    Details of problems encountered processing the request.

    object

    Details of a problem encountered processing the request.

    status
    string

    The HTTP status code applicable to the problem

    title
    string

    A short-human readable description of the problem, this should not change from occurrence to occurrence.

    detail
    string

    A human-readable explanation specific to this occurrence of the problem.

    Was this article helpful?
    What's Next