# Payments API

Retrieve payment and payout details for accommodation reservations, including partner payout information, breakdowns, bank transfer details, and VCC management.

Version: 1.0

## Servers

Test using live endpoint
```
https://payments-api.booking.com/
```

## Security

### bearerAuth

Bearer token for authentication. Use your API credentials to obtain a token.

Type: http
Scheme: bearer

## Download OpenAPI description

[Payments API](https://developers.booking.com/_bundle/connectivity/docs/openapispecs/payments-api/payments-api-specification.yaml)

## Reservation payout details

Retrieve detailed partner payout information for accommodation reservations.

### Get payout details for a reservation

 - [GET /connectivity-payments/reservations/{reservation-id}](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/reservation-payout-details/getpayoutdetails.md): Retrieve payout details for a reservation, including the estimated amount to be collected at the property, payout status and amount, commissions and charges, VCC or bank transfer payout details, and price breakdown.

## Reservation breakdown

Retrieve detailed breakdown for accommodation reservations with respect to partner payout.

### Get price breakdown for a reservation

 - [GET /connectivity-payments/reservations/{reservation-id}/breakdown](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/reservation-breakdown/getpricebreakdown.md): Retrieve a detailed price breakdown for a given reservation, including VAT, applicable taxes, and fees, per each room the guest booked.

## Bank transfer payout

Retrieve Bank Transfer payout details for accommodation reservations.

### Get bank transfer payout details for a reservation

 - [GET /connectivity-payments/reservations/{reservation-id}/payout/bt](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/bank-transfer-payout/getbtdetails.md): Retrieve information on the bank transfer payout for a reservation and any changes to the payout.

## VCC payout details, per accommodation reservation

Provides VCC payout details for an accommodation reservation

### Get VCC payout details for a reservation

 - [GET /connectivity-payments/reservations/{reservation-id}/payout/vcc](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/vcc-payout-details-per-accommodation-reservation/getvccdetailsperreservation.md): Retrieve information on the virtual credit cards associated with a reservation and changes to the VCC payout.

## VCCs to be charged

Provides information of the VCCs to be charged.

### Get chargeable VCCs for a property

 - [GET /connectivity-payments/properties/{property-id}/chargeable-vccs](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/vccs-to-be-charged/getvcctochargeforproperty.md): Retrieve information on chargeable VCCs associated with a given accommodation property.

## Refundable VCCs

Provides information of the refundable VCCs.

### Get refundable VCCs for a property

 - [GET /connectivity-payments/properties/{property-id}/refundable-vccs](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/refundable-vccs/getvccrefundablesforproperty.md): Retrieve details on refundable VCCs associated with a given accommodation property.

## Reservation Status API

Provides reservation status information with respect to a reservation ID.

### Get reservation status

 - [GET /connectivity-payments/reservations/{reservation-id}/status](https://developers.booking.com/connectivity/docs/openapispecs/payments-api/payments-api-specification/reservation-status-api/getreservationstatusresponse.md): Provides status information for an accommodation reservation.