What is it?
This method is used to return refund estimation information with an assigned refund contract ID.
Why use it?
Use this method to estimate the total amount of a refund.
How it works
- Send a request to the Rail vendor system to get a refund contract by a list of
refundOptionId
elements andrefundCriteria
in the payload. Note: Requests can be sent at any time to get new refund contracts. In the Rail system, each refund contract expires after 15 minutes. -
All refund contract options are returned in a structured format, including the following information:
transactionContractId
transactionContractStatus
charges
refundedTicketsBalance
paymentBalances
Notes:
- An
ESTIMATED
transactionContractStatus
means that the refund contract can be confirmed. transactionContractId
is a field used in the refund confirmation process.charges
contains a fee charge representing the cost of this refund operation.refundedTicketsBalance
contains a price element that represents the value of all refunded tickets.paymentBalance
includes information about the transaction type and amount.transactionType
can have one of two statesCREDIT
orDEBIT
.CREDIT
includes the money to be returned to the customer.- The amount displayed in
DEBIT
is the additional amount the customer must pay.
amount
displays total amount of the refund forcredit
ordebit
.
Caution: Consuming this API and its content requires special permission. Before requesting access, please make sure you have all the necessary agreements in place with the rail vendor(s) you would like to sell using Content Services for Rail. For more information on accessing Sabre Rail content and rail supplier contacts, please visit the respective product page on Sabre Central.
Vendor | Code | Payment via API | Notes |
---|---|---|---|
SNCF | 2C | No | “On account” only. Direct settlement with agency. No individual or corporate credit cards. |
Amtrak | 2V | Yes | Access to this inventory will only be granted upon Amtrak's approval. Any new POS will be vetted and certified by Amtrak. |
How to use
Method
POST /v2/rail/orders/{marketingCarrierCode}/{orderId}/refundContracts
Request
Provide a list of refundOptionId
elements selected from the order read response, the marketingCarrierCode
, and a properly filled out refundCriteria
in the payload.
Important! All refundOptionId
elements must come from the same CompatibleRefundOption
element in the order read response.
The refundCriteria
can contain refund reason
.
Response
Returns a full, new refundContract
with all details used in the refund confirmation process.