Local Payments

Note

Tour Operator is one of G Adventures, TruTravels, or G Touring

A Local Payment resource is a read-only resource that represents a non-purchasable amount that will be paid locally (in destination) by the traveller. The currency field on the Local Payment indicates the currency in which the Local Payment is to be made. Local payments are not collected by the Tour Operator. They are exposed so you can present the full cost of a trip to the traveller, and to meet price transparency regulations.

Local Payments have a price_type of FIXED or VARIABLE.

Note: More types may be added in the future.

  • FIXED - the amount is known ahead of time. minimum_amount and maximum_amount are null.

  • VARIABLE - the exact amount depends on conditions determined at the point of payment. amount is null, and minimum_amount and maximum_amount give the expected range.

Sell Currencies

Sell Currencies are provided as a convenience for displaying prices in different currencies to the traveller. This allows the traveller to see the approximate cost of the Local Payment in the currency they are purchasing, though the actual payment as noted, will typically be made in the currency denoted by the currency field of the Local Payment.

The sell currency amounts are based on the exchange rates retrieved on the date denoted by the rate_as_of field. These are typically retrieved and updated on the 1st of each month.

Fields

Name

Type

Description

id (read-only)

String

href (read-only)

Field

label (required)

String

A label explaining the payment which can be presented to the traveller.

description (required)

String

An optional description for the payment which can be presented to the traveller.

amount (required)

Decimal

If price type is ‘FIXED’, the amount in the specified currency this payment costs, null otherwise.

currency (required)

String

The currency this payment is expected to be paid in.

price_type (required)

Choice

The type of local payment. Can be one of ‘FIXED’ or ‘VARIABLE’.

included_in_approximate_total (required)

Boolean

Whether this local payment is included as part of the computation of the approximate_amount_with_local_payments fields.

minimum_amount (required)

Decimal

If price type is ‘VARIABLE’, the minimum amount in the specified currency this payment costs, null otherwise.

maximum_amount (required)

Decimal

If price type is ‘VARIABLE’, the maximum amount in the specified currency this payment costs, null otherwise.

rate_as_of (required)

Date

The date the exchange rate used in sell_currencies was last updated.

sell_currencies (required)

Field

The local payment converted into our different sell currencies.

  • amount (required)

Decimal

If price type is ‘FIXED’, the amount in the specified currency this payment costs, null otherwise.

  • currency (required)

String

The currency for the converted amount of this local payment.

  • minimum_amount (required)

Decimal

If price type is ‘VARIABLE’, the minimum amount in the specified currency this payment costs, null otherwise.

  • maximum_amount (required)

Decimal

If price type is ‘VARIABLE’, the maximum amount in the specified currency this payment costs, null otherwise.

Get A Local Payment

Note

A list view is not available.

GET /local_payments/(string: local_payment_id)