Payments

This resource represents a payment made on a booking.

XML Schema:

GET: get-payment

Fields

Name Type Description
status read-only String

A list of codes that represent the current status af a transaction.

  • PENDING: The transaction is pending processing.
  • FAILED: The transaction has been been processed and failed to be approved.
  • PROCESSED: The transaction has been been processed and was approved.
error read-only Nested Object Details for failed transactions.
date_created read-only Datetime The time when the resource was created, in the standard dates-time.
date_last_modified read-only Datetime The time when the resource was last modified, in the standard dates-time.
transaction_type read-only Nested Object Information about the type of transaction.
  • name required
 String A brief description of the transaction type.
  • code required
 String The unique code for this transaction type.
booking required Reference Object The related booking resource.
amount required Decimal The currency-specific amount of rhe transaction, in the standard currencies.
customer required Reference Object The related customer resource.
capture Boolean If false, authorize but do not capture payment (optional; default: true)
details required Nested Object  
  • transaction_type_code required
 String Transaction type. Currently, only CREDIT_CARD is supported.
  • number required
 String Credit card number
  • expiry_month required
 String Card expiry month (2 digits)
  • expiry_year required
 String Card expiry year (4 digits)
  • cvv required
 String Card verification value (3-4 digits)
  • name_on_card required
 String Booking note (optional)
note String Booking note (optional)
id read-only String  
href read-only Field  

Get a Payment

GET /payments/(string: payment_id)/