# Yolcu360 Agency API Documentation

Detailed technical documentation for Yolcu360 Agency API

Version: 1.0.0

Metadata:
  - title: Yolcu360 Agency API Documentation
  - titleTranslationKey: common.title
  - description: Detailed technical documentation for Yolcu360 Agency API
  - descriptionTranslationKey: common.description
  - version: 1.0.0

## Servers

Staging server
```
https://staging.api.pro.yolcu360.com/api/v1
```

Production server
```
https://api.pro.yolcu360.com/api/v1
```

## Security

### BearerAuth

[object Object]

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

 - [Yolcu360 Agency API Documentation](https://apidocs.yolcu360.com/_bundle/@l10n/tr-TR/api/api.yaml)

## Health

 - [GET /health](https://apidocs.yolcu360.com/tr-tr/api/api/health/gethealthstatus.md): Returns the health status of the BFF Agency service in JSON format. This endpoint provides service name, status, and timestamp information.
## Auth

 - [POST /auth/login](https://apidocs.yolcu360.com/tr-tr/api/api/auth/authenticatewithapikey.md): Authenticates a user with the provided API key and secret. On success, returns access and refresh tokens along with their expiration datetimes.
 - [POST /auth/refresh](https://apidocs.yolcu360.com/tr-tr/api/api/auth/refreshaccesstoken.md): Refreshes the access token using a valid refresh token. The refresh token must be provided in the request body.
## Locations

 - [GET /locations](https://apidocs.yolcu360.com/tr-tr/api/api/locations/searchlocations.md): Retrieves location suggestions based on a search query. This endpoint is typically used for autocomplete functionality.
 - [GET /locations/{placeId}](https://apidocs.yolcu360.com/tr-tr/api/api/locations/getlocationdetails.md): Retrieves detailed information for a location using its unique place ID.
## Search

 - [POST /search/point](https://apidocs.yolcu360.com/tr-tr/api/api/search/searchwithpoint.md): Searches for available car rental options based on provided search criteria including location coordinates, dates, age, and payment preferences. Returns a list of car options with complete details in
 - [GET /search/{searchID}/{code}/extra-products](https://apidocs.yolcu360.com/tr-tr/api/api/search/getcarextraproducts.md): Retrieve extra products for a specific car using search ID and product code.
## Order

 - [POST /order](https://apidocs.yolcu360.com/tr-tr/api/api/order/createorder.md): Creates a new order with the provided details, including payment type, search ID, code, extra products, passenger, and billing information.
 - [GET /order/{orderID}](https://apidocs.yolcu360.com/tr-tr/api/api/order/getorder.md): Retrieve the details of an order using its unique order ID.
 - [POST /order/{orderID}/cancel_eligibility](https://apidocs.yolcu360.com/tr-tr/api/api/order/checkcanceleligibility.md): Checks whether an order is eligible for cancellation and refund. This endpoint does not modify the order but provides information about the cancellation and refund eligibility status.
 - [POST /order/{orderID}/cancel](https://apidocs.yolcu360.com/tr-tr/api/api/order/cancelorder.md): Cancels an existing order. The order must be in a cancellable state. This endpoint will attempt to cancel the order with the vendor and update the order status accordingly.
## Payment

 - [POST /payment/pay](https://apidocs.yolcu360.com/tr-tr/api/api/payment/processpayment.md): Processes payment for an existing order using either credit card or credit limit. For credit card payments, may return 3D Secure HTML content if 3DS is enabled. For successful payments, the order will
 - [POST /payment/installment-info](https://apidocs.yolcu360.com/tr-tr/api/api/payment/getinstallmentinfo.md): Retrieves installment options and pricing information for a specific card based on the BIN number and order details.
## Helper Data

 - [GET /helper-data/car-classes](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/getcarclasses.md): Retrieves all available car classes used for car rental classification. This endpoint provides the standard car class categories such as Economy, Compact, etc.
 - [GET /helper-data/fuel-types](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/getfueltypes.md): Retrieves all available fuel types for rental vehicles. This includes options like Petrol, Diesel, Electric, Hybrid, etc.
 - [GET /helper-data/transmission-types](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/gettransmissiontypes.md): Retrieves all available transmission types for rental vehicles. This includes options like Automatic, Manual, CVT, etc.
 - [GET /helper-data/delivery-types](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/getdeliverytypes.md): Retrieves all available delivery types for car rental services. This includes options like Airport Delivery, Hotel Delivery, Office Pickup, etc.
 - [GET /helper-data/suppliers](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/getsuppliers.md): Retrieves all available car rental suppliers and subsuppliers for agency integration. This endpoint provides the complete list of suppliers that agencies can work with, including their codes, display
 - [GET /helper-data/extra-products](https://apidocs.yolcu360.com/tr-tr/api/api/helper-data/getextraproducts.md): Retrieves all available extra product types for car rentals. This includes options like Baby Seat, GPS Navigation, Additional Driver, Insurance packages, etc. The names are translated based on the Acc
## Findeks

 - [POST /findeks/check](https://apidocs.yolcu360.com/tr-tr/api/api/findeks/checkfindekseligibility.md): Checks whether a customer is eligible for Findeks credit scoring based on their identity information. This endpoint verifies the customer's eligibility to rent vehicles that require Findeks credit che
 - [POST /findeks/phone-list](https://apidocs.yolcu360.com/tr-tr/api/api/findeks/getfindeksphonelist.md): Retrieves the list of phone numbers registered to a customer in the Findeks system. This information is required for the Findeks credit verification process.
 - [POST /findeks/report](https://apidocs.yolcu360.com/tr-tr/api/api/findeks/generatefindeksreport.md): Generates a comprehensive Findeks credit report for a customer using their complete information including identity details, phone number, and license information.
 - [POST /findeks/pin-confirm](https://apidocs.yolcu360.com/tr-tr/api/api/findeks/confirmfindekspin.md): Confirms the customer's Findeks PIN to authorize the credit check process. This step is required after receiving a PIN via SMS during the Findeks verification.
 - [POST /findeks/pin-renew](https://apidocs.yolcu360.com/tr-tr/api/api/findeks/renewfindekspin.md): Requests a new Findeks PIN for the customer to authorize the credit check process. This can be used when the original PIN has expired or was not received.
