Bookings Payments

Overview

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

Parameters

OAuth Scopes:

payments_read / payments_write

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

OAuth Scopes:

payments_read / payments_write

response.json

{
  "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": [
    {
      "links": {
        "account": 44,
        "booking": 22,
        "payment": 11,
        "rental": 30
      },
      "id": 2,
      "amount_in_cents": 100000,
      "currency": "USD",
      "created_at": "2025-03-17T22:18:29.723Z",
      "updated_at": "2025-03-24T22:18:29.723Z"
    }
  ],
  "meta": {}
}

Get a single bookings payment

Returns a single bookings payment identified by ID.

GET /bookings_payments/:bookings_payment_id

OAuth Scopes:

payments_read / payments_write

response.json

{
  "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": [
    {
      "links": {
        "account": 44,
        "booking": 22,
        "payment": 11,
        "rental": 30
      },
      "id": 2,
      "amount_in_cents": 100000,
      "currency": "USD",
      "created_at": "2025-03-17T22:18:29.726Z",
      "updated_at": "2025-03-24T22:18:29.726Z"
    }
  ],
  "meta": {}
}