Skip to main content

Custom Refund/cancel end-point, all options available

DELETE 
/order/:guid/custom_refund

Custom Refund/cancel end-point, all options available. This endpoint can cancel and refund Orders, Tickets, Products, and Payment fees. The Tickets, Products, and Payment fees can be cancelled/refunded through items, while the Order can be cancelled/refunded through entire_order.

Request​

Path Parameters

    guid stringrequired

    The guid of the Order.

Body

Input data

    refund boolean

    If true, the request will be refunded, otherwise the request is only cancelled.

    comment stringrequired

    Possible values: non-empty and <= 255 characters

    A comment for the Refund.

    includes_fees booleanrequired

    Whether to include the services fees.

    entire_order booleanrequired

    Whether to refund the entire order.

    items

    object[]

    required

  • Array [

    • guid uuidrequired

    The guid of the item to be refunded.

    type stringrequired

    Possible values: [payment, ticket, product]

    The type of the item to be refunded.

  • ]

    • arbitrary

    object

    Use this to overwrite the value to be refunded. If this is left empty the value of the items or Order will be taken instead.

    amount integerrequired

    The amount to be refunded in cents.

    vat integerrequired

    The vat to be refunded.

Responses​

Empty response when cancel was successful

Schema

    fatals

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    errors

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    notices

    object

    subjectType stringrequired

    The type of object which throws the fatal, error or notice.

    guid stringrequired

    The guid of the object which threw the fatal, error or notice.

    reservation string

    In the case the error is about reservation, this will be the reservation key of the object that was used.

    reason string

    The reason why the fatal, error or notice occurred.

    extra object

    Potentially some extra information about the fatal, error or notice.

    parentOf object

    This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.

    redirectUrl string

    The redirect URL to where the user should continue.

    amount float

    In case this field is returned, it is the amount of the created Order in cents.

    order_id string

    The guid of the created Order.

Loading...