--- title: "Get payout details for a reservation" method: GET path: "/connectivity-payments/reservations/{reservation-id}" tags: ["Reservation payout details"] --- # Get payout details for a reservation `GET /connectivity-payments/reservations/{reservation-id}` 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. ## Path parameters - `reservation-id` integer, required ## Headers - `accept-version` string - `Authorization` string, required ## Response `200` Successfully retrieved payout details 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. - PayoutDetailsResponse — Response containing detailed payout information for a reservation - `meta` DefaultMeta — Metadata for the response - `ruid` string — Request unique identifier - `data` PayoutDetails — Detailed payout information for a reservation - `reservation_id` string — Accommodation reservation identifier - `property_id` string — Property identifier - `payout_type` string — Type of payout: GROSS, NET, or UNKNOWN. - `payout_status` string — Status of the payout: PENDING, PAID, PARTIALLY_PAID, CANCELLED, or UNKNOWN. - `payment_tags` string[] — Payment tags associated with the reservation. - `total_price_of_reservation` object — Breakdown of the total reservation price - `total_amount_paid` AmountPaid — Contains information on the total amount the guest paid to Booking.com. - `currency` string — Currency of the amount. - `value` string — Amount paid by the guest. - `decimals` integer — Number of decimals in the amount. - `total_amount_to_collect_at_property` AmountToCollect — Contains information on the estimated amount the partner needs to collect from the guest at checkin. - `currency` string — Currency of the amount. - `value` string — Estimated amount to be collected from the guest at checkin. - `decimals` integer — Number of decimals in the amount. - `partner_payout` object — Partner payout summary - `total_payout` AmountPayout — Contains information on the total amount to be paid out to the partner. - `currency` string — Currency of the amount. - `value` string — Total payout amount. - `decimals` integer — Number of decimals in the amount. - `commissionable_price` AmountCommissionable — Contains information on the total commissionable price. - `currency` string — Currency of the amount. - `value` string — Total commissionable price. - `decimals` integer — Number of decimals in the amount. - `commissions_and_charges` AmountCommissionsAndCharges — Contains information on the total amount of commissions and other charges such as fees. - `currency` string — Currency of the amount. - `value` string — Total amount of commissions and other charges. - `decimals` integer — Number of decimals in the amount. - `breakdown` object — Breakdown of commissions and charges. - `total_commissions` object — Total commission amount. - `currency` string — Currency of the amount. - `value` string — Total commission amount. - `decimals` integer — Number of decimals in the amount. - `total_charges` object — Total charges amount. - `currency` string — Currency of the amount. - `value` string — Total charges amount. - `decimals` integer — Number of decimals in the amount. - `payout` object — Payout instruments - `bank_transfers` object[] — Bank transfer payouts - `amount` object — Contains information on the amount to be transferred. - `value` string — Payout amount. - `currency` string — Currency of the amount. - `decimals` integer — Number of decimals in the amount. - `status` string — Status of the bank transfer payout: PENDING, PAID, or UNKNOWN. - `payout_date` string — Date the amount is to be paid out to the partner. Format: YYYY-MM-DD. - `bank_transfer_reference` string — Identifier of the bank transfer payout. - `virtual_credit_cards` PayoutVCC[] — Virtual credit card payouts - `activation_date` string, date — Date the VCC becomes active - `id` string, required — VCC identifier - `current_balance` AmountVCCBalance, required — Contains information on the current balance of the VCC. - `currency` string — Currency of the amount. - `value` string — Current balance of the VCC. - `decimals` integer — Number of decimals in the amount. - `expiration_date` string, date — Date the VCC expires - `status` string, required — Possible VCC status values: NOT_LOADED, FUNDED, AVAILABLE, PARTIALLY_CHARGED, FULLY_CHARGED, CANCELLED, or UNKNOWN. - `card_details` VCCCardDetails, required — Card details for a virtual credit card - `cvc` string, required — Card verification code - `card_name` string, required — Name on the card - `card_number` string, required — Card number - `card_type` string — Type of the VCC - `card_expiry` string, required — Card expiry date (MM/YY) - `customer_credit_cards` object[] — Reserved for future Payments API updates. - `price_breakdown` object[] — Per-room price breakdown - `room_reservation_id` string — Room reservation identifier - `charges` object[] - `type` string — Charge type (e.g. Tax, COMMISSION) - `amount` AmountCharges — Contains information on the total amount of all charges. - `currency` string — Currency of the amount. - `value` string — Total amount of all charges. - `decimals` integer — Number of decimals in the amount. - `is_already_collected_from_guest` string — If set to TRUE, the charged amount has already been collected from the guest and the partner does not need to collect anything. If set to FALSE, the partner has to collect the money at checkin. If set to UNKNOWN, no information is available. - `is_included_total_partner_payout` string — If set to TRUE, the charged amount is included in the payout and will be transferred to the partner. If set to FALSE, the charged amount is intended for another party, such as the government. If set to UNKNOWN, no information is available. - `applicable_rate` object, nullable — The rate applied to calculate the charge. - `type` string — How the rate is applied (e.g. PERCENTAGE). - `value` string — Rate value. - `decimals` integer — Number of decimals in the rate value. - `applicable_type` string[], nullable — The type of applicable rate. - `errors` unknown[] - unknown - `warnings` unknown[] - unknown ## Other responses - `400` — Invalid request payload. - `401` — Unauthorized. Missing or invalid authentication token. - `403` — Access Denied! - `404` — The reservation data is not found at this moment. - `410` — Reservation cannot be processed because the checkout date is older than the allowed 18-months window. - `429` — You exceeded the rate limit. - `500` — The request failed with an internal server error. --- [API](https://skmtc.net/booking/apis/payments-api.md) · [All operations](https://skmtc.net/booking/apis/payments-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/booking/payments-api/revisions/3c0b3d08cb90/schema)