# \RefundApi
All URIs are relative to *https://s3p-osdm.cloud.sqills.com*
[**delete_refund_offers**](RefundApi.md#delete_refund_offers) | **DELETE** /bookings/{bookingId}/refund-offers/{refundOfferId} | Deletes a refundOffer without waiting for expiry.
[**get_refund_offers**](RefundApi.md#get_refund_offers) | **GET** /bookings/{bookingId}/refund-offers/{refundOfferId} | Returns the refund offer for the ids provided.
[**patch_refund_offers**](RefundApi.md#patch_refund_offers) | **PATCH** /bookings/{bookingId}/refund-offers/{refundOfferId} | Allows to accept and confirm a refund offer.
[**post_prepare_refund_offers**](RefundApi.md#post_prepare_refund_offers) | **GET** /bookings/{bookingId}/refund-offers/{refundOfferId}/confirmation-check | Validation step (step 1 in a two phase commit process) to run before the effective patch endpoint. Provider do all checks to \"guarantee\" that refund will work.
[**post_refund_offers**](RefundApi.md#post_refund_offers) | **POST** /bookings/{bookingId}/refund-offers | Initiates a refund process by creating a refundOffer resource.
## delete_refund_offers
> delete_refund_offers(booking_id, refund_offer_id, requestor, accept_language, traceparent, tracestate)
Deletes a refundOffer without waiting for expiry.
In case the unconfimed refund offer is not sored in the booking object the delete request must return an ok (http 204). In case the refund offer is already confirmed and can not be deleted the reply must be an error (http 409 conflict).
### Parameters
**booking_id** | **String** | id of the booking | [required] |
**refund_offer_id** | **String** | id of the refund offer | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
### Return type
(empty response body)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_refund_offers
> models::RefundOfferResponse get_refund_offers(booking_id, refund_offer_id, requestor, accept_language, traceparent, tracestate, x_accept_namespace)
Returns the refund offer for the ids provided.
### Parameters
**booking_id** | **String** | id of the booking | [required] |
**refund_offer_id** | **String** | id of the refund offer to get. | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::RefundOfferResponse**](RefundOfferResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## patch_refund_offers
> models::RefundOfferResponse patch_refund_offers(booking_id, refund_offer_id, refund_offer_patch_request, requestor, accept_language, traceparent, tracestate, idempotency_key, x_accept_namespace)
Allows to accept and confirm a refund offer.
### Parameters
**booking_id** | **String** | id of the booking | [required] |
**refund_offer_id** | **String** | id of the refund offer | [required] |
**refund_offer_patch_request** | [**RefundOfferPatchRequest**](RefundOfferPatchRequest.md) | | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**idempotency_key** | Option<**uuid::Uuid**> | The HTTP Idempotency request header field can be used to carry idempotency key in order to make non-idempotent HTTP methods such as POST or PATCH fault-tolerant. Servers should keep the idempotency key for as long as the result of the underlying operation is valid. Idempotency keys should be globally unique. | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::RefundOfferResponse**](RefundOfferResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_prepare_refund_offers
> post_prepare_refund_offers(booking_id, refund_offer_id, requestor, accept_language, traceparent, tracestate, idempotency_key, x_accept_namespace)
Validation step (step 1 in a two phase commit process) to run before the effective patch endpoint. Provider do all checks to \"guarantee\" that refund will work.
Step 1 in a two phase commit process. An aggregator can use this to secure that all underlaying provider systems are up and running and the provider booking is ready to be refunded.
### Parameters
**booking_id** | **String** | id of the booking | [required] |
**refund_offer_id** | **String** | id of the refund offer | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**idempotency_key** | Option<**uuid::Uuid**> | The HTTP Idempotency request header field can be used to carry idempotency key in order to make non-idempotent HTTP methods such as POST or PATCH fault-tolerant. Servers should keep the idempotency key for as long as the result of the underlying operation is valid. Idempotency keys should be globally unique. | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
(empty response body)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## post_refund_offers
> models::RefundOfferCollectionResponse post_refund_offers(booking_id, refund_offer_request, requestor, accept_language, traceparent, tracestate, idempotency_key, x_accept_namespace)
Initiates a refund process by creating a refundOffer resource.
The RefundOffer contains the required information on the potential operation. One refund offer can then be accepted via a PATCH, deleted or left to die at the end of its lifetime.
### Parameters
**booking_id** | **String** | id of the booking. | [required] |
**refund_offer_request** | [**RefundOfferRequest**](RefundOfferRequest.md) | | [required] |
**requestor** | Option<**String**> | The requestor header contains detailed information about who is calling the API. It can include information such as channel, organization, sales unit or workstation id and be used to configure e.g. the fare range provided to the caller. The content of the string is part of a bilateral contract by the two parties and not standardized by OSDM. It is recommend to encrypt the information transferred. | |
**accept_language** | Option<**String**> | Describes the set of natural languages that are preferred for localized text in the response to the request (see RFC9110). Supporting English (en) is a must. | |
**traceparent** | Option<**String**> | The traceparent header describes the position of the incoming request in its trace graph in a portable, fixed-length format. Its design focuses on fast parsing. Every tracing tool MUST properly set traceparent even when it only relies on vendor-specific information in tracestate (see W3C Trace Context). | |
**tracestate** | Option<**String**> | The tracestate extends traceparent with vendor-specific data represented by a set of name/value pairs. Storing information in tracestate is optional (see W3C Trace Context). | |
**idempotency_key** | Option<**uuid::Uuid**> | The HTTP Idempotency request header field can be used to carry idempotency key in order to make non-idempotent HTTP methods such as POST or PATCH fault-tolerant. Servers should keep the idempotency key for as long as the result of the underlying operation is valid. Idempotency keys should be globally unique. | |
**x_accept_namespace** | Option<**String**> | The x-accept-namespace HTTP header indicates the URN namespace that the client prefers. The provider uses content-negotiation to apply the corresponding namespace(s) where applicable. | |
### Return type
[**models::RefundOfferCollectionResponse**](RefundOfferCollectionResponse.md)
### Authorization
[oAuth2ClientCredentials](../README.md#oAuth2ClientCredentials)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json, application/problem+json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)