Refunds

Refunds is a resource that contains a collection of 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.

  • Order token: The token of the order that we want its refunds.
  • Cognito token: The user represented by the token must be the creator of the order associated with this refund.

Embedded resources

A collection of Refund.

Example representation

[GET] https://shopping-api.paylogic.com/refunds?order=https://shopping-api.paylogic.com/orders/a9211319a7bf4c1d82b78d536c92de58
{
    "_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",
                "amount": {
                    "amount": "6.50",
                    "currency": "EUR"
                },
                "created_at": "2022-08-29T10:59:14Z",
                "last_updated": "2022-08-29T10:59:14Z"
            }
        ]
    }
}

Retrieve a single refund

Retrieve one Refund item with the refund uid.

Example representation

[GET] https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09
{
    "_links": {
        "self": {
            "href": "https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09"
        }
    },
    "uid": "4221f0abd8bc4e768272b483cd929d09",
    "status": "requested",
    "amount": {
        "amount": "6.50",
        "currency": "EUR"
    },
    "created_at": "2022-08-29T10:59:14Z",
    "last_updated": "2022-08-29T10:59:14Z"
}