Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Bookings Payments

  1. Overview
  2. List bookings payments
  3. Get a single bookings payment

Overview

This resource represents the Booking’s Payments, establishing the relationship between Payments and Bookings.

Parameters

Name Type Read/Write Description
account Integer Read Account’s ID related to the Bookings Payment
booking Integer Read Booking’s ID related to the Bookings Payment
rental Integer Read Rental’s ID related to the Bookings Payment
payment Integer Read Rental’s ID related to the Bookings Payment
id Integer Read Bookings Payment’s id.
amount_in_cents Integer Read Bookings Payment’s amount in cents.
currency String Read Bookings Payment’s currency code, list of codes described in enums section.
created_at Time Read Bookings Payment’s create time.
updated_at Time Read Bookings Payment’s update time.

List bookings payments

List all bookings payments for a given account.

GET /bookings_payments

Response

{
  "links": {
    "bookings_payments.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_payments.account}",
    "bookings_payments.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_payments.booking}",
    "bookings_payments.payment": "https://www.bookingsync.com/api/v3/payments/{bookings_payments.payment}",
    "bookings_payments.rental": "https://www.bookingsync.com/api/v3/rentals/{bookings_payments.rental}"
  },
  "bookings_payments": [
    {
      "id": 2,
      "amount_in_cents": 100000,
      "currency": "USD",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "links": {
        "account": 44,
        "booking": 22,
        "payment": 11,
        "rental": 30
      }
    }
  ],
  "meta": {
  }
}

Get a single bookings payment

Returns a single bookings payment identified by ID.

GET /bookings_payments/:bookings_payment_id

Response

{
  "links": {
    "bookings_payments.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_payments.account}",
    "bookings_payments.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_payments.booking}",
    "bookings_payments.payment": "https://www.bookingsync.com/api/v3/payments/{bookings_payments.payment}",
    "bookings_payments.rental": "https://www.bookingsync.com/api/v3/rentals/{bookings_payments.rental}"
  },
  "bookings_payments": [
    {
      "id": 2,
      "amount_in_cents": 100000,
      "currency": "USD",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "links": {
        "account": 44,
        "booking": 22,
        "payment": 11,
        "rental": 30
      }
    }
  ],
  "meta": {
  }
}