Refunds is a resource that contains a collection of Refund.
GET: Retrieve the list of refunds.
Parameter |
Type |
Description |
|---|---|---|
order |
String |
URI of the order. |
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.
A collection of Refund.
[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",
"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 one Refund item with the refund uid.
[GET] https://shopping-api.paylogic.com/refunds/4221f0abd8bc4e768272b483cd929d09
{
"_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"
}