*******
Refunds
*******
Refunds is a resource that contains a collection of :doc:`/objects/refund`.


Accepted methods
================
* **GET**: Retrieve the list of refunds.


Accepted query parameters
=========================
========================  ==============================================  ==============================================
Parameter                 Type                                            Description
========================  ==============================================  ==============================================
order                     String                                          URI of the order.
========================  ==============================================  ==============================================


Authentication
--------------
The retrieval of the refund collection or a single refund can be authenticated in multiple ways.

- :ref:`order-token`: The token of the order that we want its refunds.
- :ref:`cognito-token`: The user represented by the token must be the creator of the order associated with this refund.


Embedded resources
==================
A collection of :doc:`/objects/refund`.


Example representation
======================
.. code-block:: bash

    [GET] https://shopping-api.paylogic.com/refunds?order=https://shopping-api.paylogic.com/orders/a9211319a7bf4c1d82b78d536c92de58

.. code-block:: javascript

    {
        "_links": {
            "self": {
                "href": "https://shopping-api.paylogic.com/refunds"
            },
            "curies": [
                {
                    "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
                    "name": "shop",
                    "templated": true,
                    "type": "text/html"
                }
            ]
        },
        "_embedded": {
            "shop:refunds": [
                {
                    "_links": {
                        "self": {
                            "href": "https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09"
                        }
                    },
                    "uid": "4221f0abd8bc4e768272b483cd929d09",
                    "status": "requested",
                    "type": "psp",
                    "amount_breakdown": {
                        "total": {
                            "amount": "6.50",
                            "currency": "EUR"
                        },
                        "other": {
                            "amount": "4.50",
                            "currency": "EUR"
                        },
                        "by_tickets": [
                            {
                                "product_name": {
                                    "de": "",
                                    "en": "Simple entrance",
                                    "es": "",
                                    "fr": "",
                                    "nl": "",
                                    "pt": "",
                                    "tr": ""
                                },
                                "amount": {
                                    "amount": "1.00",
                                    "currency": "EUR"
                                }
                            },
                            {
                                "product_name": {
                                    "de": "",
                                    "en": "Simple entrance",
                                    "es": "",
                                    "fr": "",
                                    "nl": "",
                                    "pt": "",
                                    "tr": ""
                                },
                                "amount": {
                                    "amount": "1.00",
                                    "currency": "EUR"
                                }
                            }
                        ]
                    },
                    "direct_refund_status": "not_initiated",
                    "created_at": "2022-08-29T10:59:14Z",
                    "last_updated": "2022-08-29T10:59:14Z"
                }
            ]
        }
    }


Retrieve a single refund
========================
Retrieve one :doc:`/objects/refund` item with the refund uid.


Example representation
======================
.. code-block:: bash

    [GET] https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09

.. code-block:: javascript

    {
        "_links": {
            "self": {
                "href": "https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09"
            }
        },
        "uid": "4221f0abd8bc4e768272b483cd929d09",
        "status": "requested",
        "type": "psp",
        "amount_breakdown": {
            "total": {
                "amount": "6.50",
                "currency": "EUR"
            },
            "other": {
                "amount": "4.50",
                "currency": "EUR"
            },
            "by_tickets": [
                {
                    "product_name": {
                        "de": "",
                        "en": "Simple entrance",
                        "es": "",
                        "fr": "",
                        "nl": "",
                        "pt": "",
                        "tr": ""
                    },
                    "amount": {
                        "amount": "1.00",
                        "currency": "EUR"
                    }
                },
                {
                    "product_name": {
                        "de": "",
                        "en": "Simple entrance",
                        "es": "",
                        "fr": "",
                        "nl": "",
                        "pt": "",
                        "tr": ""
                    },
                    "amount": {
                        "amount": "1.00",
                        "currency": "EUR"
                    }
                }
            ]
        },
        "direct_refund_status": "not_initiated",
        "created_at": "2022-08-29T10:59:14Z",
        "last_updated": "2022-08-29T10:59:14Z"
    }