The refund bill resource allows you to generate a refund bill for a collection of tickets in combination with several settings. This refund bill will state what the order consumer is allowed to get refunded, by taking into account all applicable settings, and using validation logic to determine the credibility of the tickets.
Please note that the refund bill resource is merely a snapshot of the credibility of tickets, which is only accurate at the time it is generated. Due to the possibility that configurations could change in between generating the refund bill and executing the refund, there is no guarantee that this is exactly what the order consumer will be allowed to refund after placing the request for a refund. This should be made clear to the consumer during the refunding process. In general, the refund process consists of the following flow:
Requesting a build up of the refund. See below for more information.
Requesting a refund. See Refund requests.
Viewing the refunds related to a refund request. See Refunds.
The refund bill works by splitting the refund amount over different groups.
Each group is responsible for a specific part of the refund.
For example, the "products" group is responsible for the credibility of the tickets.
And the "service_costs" is responsible for the credibility of the service costs related to these tickets.
GET: Generate a refund bill for a collection of tickets.
There are several use cases for generating a refund bill. These are:
Generating a refund bill for resale.
Generating a refund bill for the waiting list.
Generating a refund bill for changing orders.
The following payload is an example of how to generate a refund bill for resale. Note that the payload must be provided in the query params, since it is a GET request. The request must be authenticated using either the Order token or Cognito token belonging to the order of the tickets.
{
"source": "resale",
"tickets": [
"https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
],
"sale": "https://shopping-api.paylogic.com/sales/c136f2d9add9493ba5ca51ae48f4340e",
"asking_price": "EUR+7.34"
}
The payload above is encoded into the following URL (please note that amount-values are serialized differently in query-params):
[GET] https://shopping-api.paylogic.com/refund-bill?source=resale&tickets=https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052&sale=https://shopping-api.paylogic.com/sales/c136f2d9add9493ba5ca51ae48f4340e&asking_price=EUR+7.34
Example response
{
"refund_amount": {
"amount": "7.34",
"currency": "EUR"
},
"change_order_amount": {
"amount": "0.00",
"currency": "EUR"
},
"voucher_amount": {
"amount": "0.00",
"currency": "EUR"
},
"products": {
"label": "Products",
"amount": {
"amount": "7.34",
"currency": "EUR"
},
"items": [
{
"label": "Saturday ticket",
"unit_price": {
"amount": "7.34",
"currency": "EUR",
},
"quantity": null,
"amount": {
"amount": "7.34",
"currency": "EUR"
},
"is_included": true,
"exclusion_reasons": [],
"_links": {
"ticket": {
"href": "https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
},
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
{
"label": "Saturday ticket",
"unit_price": {
"amount": "2.66",
"currency": "EUR",
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"This ticket is excluded."
],
"_links": {
"ticket": {
"href": "https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
},
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
}
]
},
"product_fees": {
"label": "Product fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"discounts": {
"label": "Discount",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"external_purchases": {
"label": "External purchases",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"fulfillment": {
"label": "Shipping costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Shipping costs",
"unit_price": {
"amount": "6.78",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The shipping fee is excluded."
]
}
]
},
"service_costs": {
"label": "Service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Simple product 1",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": 1,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The product related to this item is excluded."
],
"_links": {
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
{
"label": "Service fee",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The order level service fees are excluded."
]
}
]
},
"credit_vouchers": {
"label": "Credit vouchers",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"insurance": {
"label": "Refund protection",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"payment": {
"label": "Payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Payment costs",
"unit_price": {
"amount": "1.20",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The payment fee is excluded."
]
}
]
},
"refunds": {
"label": "Refunds",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"change_refund_request": {
"label": "Change refund request",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"refund_service_fees": {
"label": "Refund service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Refund service fee",
"unit_price": {
"amount": "0.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The refund fee is free."
]
}
]
},
"paylogic_refund_fees": {
"label": "Refund payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"errors": []
}
The following payload is an example of how to generate a refund bill for the waiting list. Note that the payload must be provided in the query params, since it is a GET request. The request must be authenticated using either the Order token or Cognito token belonging to the order of the tickets.
{
"source": "waiting_list",
"tickets": [
"https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
],
"sale": "https://shopping-api.paylogic.com/sales/c136f2d9add9493ba5ca51ae48f4340e",
}
The payload above is encoded into the following URL:
[GET] https://shopping-api.paylogic.com/refund-bill?source=waiting_list&tickets=https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052&sale=https://shopping-api.paylogic.com/sales/c136f2d9add9493ba5ca51ae48f4340e
Example response
{
"refund_amount": {
"amount": "10.00",
"currency": "EUR"
},
"change_order_amount": {
"amount": "0.00",
"currency": "EUR"
},
"voucher_amount": {
"amount": "0.00",
"currency": "EUR"
},
"products": {
"label": "Products",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"items": [
{
"label": "Saturday ticket",
"unit_price": {
"amount": "10.00",
"currency": "EUR",
},
"quantity": null,
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"is_included": true,
"exclusion_reasons": [],
"_links": {
"ticket": {
"href": "https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
},
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
]
},
"product_fees": {
"label": "Product fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"discounts": {
"label": "Discount",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"external_purchases": {
"label": "External purchases",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"fulfillment": {
"label": "Shipping costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Shipping costs",
"unit_price": {
"amount": "6.78",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The shipping fee is excluded."
]
}
]
},
"service_costs": {
"label": "Service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Simple product 1",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": 1,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The product level service fees are excluded."
],
"_links": {
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
{
"label": "Service fee",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The product related to this item is excluded."
]
}
]
},
"credit_vouchers": {
"label": "Credit vouchers",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"insurance": {
"label": "Refund protection",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"payment": {
"label": "Payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Payment costs",
"unit_price": {
"amount": "1.20",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The payment fee is excluded."
]
}
]
},
"refunds": {
"label": "Refunds",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"change_refund_request": {
"label": "Change refund request",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"refund_service_fees": {
"label": "Refund service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Refund service fee",
"unit_price": {
"amount": "0.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The refund fee is free."
]
}
]
},
"paylogic_refund_fees": {
"label": "Refund payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"errors": []
}
The following payload is an example of how to generate a refund bill for changing orders. Note that the payload must be provided in the query params, since it is a GET request. The request must be authenticated using either the Order token or Cognito token belonging to the order of the tickets.
{
"source": "change_order",
"tickets": [
"https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
],
"change_order_config": "https://shopping-api.paylogic.com/change_order_config/c136f2d9add9493ba5ca51ae48f4340e",
}
The payload above is encoded into the following URL:
[GET] https://shopping-api.paylogic.com/refund-bill?source=change_order&tickets=https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052&change_order_config=https://shopping-api.paylogic.com/change_order_config/c136f2d9add9493ba5ca51ae48f4340e
Example response
{
"refund_amount": {
"amount": "0.00",
"currency": "EUR"
},
"change_order_amount": {
"amount": "10.00",
"currency": "EUR"
},
"voucher_amount": {
"amount": "0.00",
"currency": "EUR"
},
"products": {
"label": "Products",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"items": [
{
"label": "Saturday ticket",
"unit_price": {
"amount": "10.00",
"currency": "EUR",
},
"quantity": null,
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"is_included": true,
"exclusion_reasons": [],
"_links": {
"ticket": {
"href": "https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
},
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
]
},
"product_fees": {
"label": "Product fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"discounts": {
"label": "Discount",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"external_purchases": {
"label": "External purchases",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"fulfillment": {
"label": "Shipping costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Shipping costs",
"unit_price": {
"amount": "6.78",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The shipping fee is excluded."
]
}
]
},
"service_costs": {
"label": "Service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Simple product 1",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": 1,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The product level service fees are excluded."
],
"_links": {
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
{
"label": "Service fee",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The service fees of non-creditable tickets."
]
}
]
},
"credit_vouchers": {
"label": "Credit vouchers",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"insurance": {
"label": "Refund protection",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"payment": {
"label": "Payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Payment costs",
"unit_price": {
"amount": "1.20",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The payment fee is excluded."
]
}
]
},
"refunds": {
"label": "Refunds",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"change_refund_request": {
"label": "Change refund request",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"refund_service_fees": {
"label": "Refund service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Refund service fee",
"unit_price": {
"amount": "0.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The refund fee is free."
]
}
]
},
"paylogic_refund_fees": {
"label": "Refund payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"errors": []
}
GET: Generate a refund bill from an existing refund request.
This is useful for retrieving the current build up of an existing refund request.
{
"refund_request": "https://shopping-api.paylogic.com/refund_request/3e0f8936210d444c884ec995ef5dd052",
}
The payload above is encoded into the following URL:
[GET] https://shopping-api.paylogic.com/refund-bill?refund_request=https://shopping-api.paylogic.com/refund_request/3e0f8936210d444c884ec995ef5dd052
{
"refund_amount": {
"amount": "10.00",
"currency": "EUR"
},
"change_order_amount": {
"amount": "0.00",
"currency": "EUR"
},
"voucher_amount": {
"amount": "0.00",
"currency": "EUR"
},
"products": {
"label": "Products",
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"items": [
{
"label": "Saturday ticket",
"unit_price": {
"amount": "10.00",
"currency": "EUR",
},
"quantity": null,
"amount": {
"amount": "10.00",
"currency": "EUR"
},
"is_included": true,
"exclusion_reasons": [],
"_links": {
"ticket": {
"href": "https://shopping-api.paylogic.com/tickets/3e0f8936210d444c884ec995ef5dd052"
},
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
]
},
"product_fees": {
"label": "Product fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"discounts": {
"label": "Discount",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"external_purchases": {
"label": "External purchases",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"fulfillment": {
"label": "Shipping costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Shipping costs",
"unit_price": {
"amount": "6.78",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The shipping fee is excluded."
]
}
]
},
"service_costs": {
"label": "Service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Simple product 1",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": 1,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The product level service fees are excluded."
],
"_links": {
"product": {
"href": "https://shopping-api.paylogic.com/products/63e7dd746733470b9da2391daa30fc3a"
}
}
},
{
"label": "Service fee",
"unit_price": {
"amount": "2.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The service fees of non-creditable tickets."
]
}
]
},
"credit_vouchers": {
"label": "Credit vouchers",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"insurance": {
"label": "Refund protection",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"payment": {
"label": "Payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Payment costs",
"unit_price": {
"amount": "1.20",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The payment fee is excluded."
]
}
]
},
"refunds": {
"label": "Refunds",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"change_refund_request": {
"label": "Change refund request",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"refund_service_fees": {
"label": "Refund service fees",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": [
{
"label": "Refund service fee",
"unit_price": {
"amount": "0.00",
"currency": "EUR"
},
"quantity": null,
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"is_included": false,
"exclusion_reasons": [
"The refund fee is free."
]
}
]
},
"paylogic_refund_fees": {
"label": "Refund payment costs",
"amount": {
"amount": "0.00",
"currency": "EUR"
},
"items": []
},
"errors": []
}