Sign in
Payments

Fetch a payment.

get/v2/payments/{id}

Path parameters

idinteger required

The payment unqiue Id.

Response

A model representing the payment.

idinteger

The ID of this record.

amountnumber

The payment amount.

booking_idinteger

The id of the booking.

collected_utcstring date-time

The timestamp the payment was collected.

descriptionstring

The payment description.

is_depositedboolean

Whether the payment has been deposited in full.

total_feesnumber

The amount of fees.

type'credit_card' | 'check' | 'cash' | 'credit_card_processed_elsewhere' | 'pay_pal' | 'bank_transfer' | 'chargeback' | 'other'

Changes

Changed in 2 of the 7 revisions of this API.2

  • 00db66c441811See the full diff
    • ○

      api operation id Payments_Get2 removed and replaced with get-payments-id

      api-operation-id-removed

  • 8856ba6a1b761See the full diff
    • ○

      added the optional property allOf[subschema #2]/deposits/items/allOf[subschema #2]/deposit_id to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog