Local Payments

A Local Payment resource represents a non-purchasable payment that is to be paid locally (on the ground) by the traveler. The Local Payment is advertised in the currency typically accepted in the destination country. It is a payment that is NOT collected by the Tour Operator and provided for informational and legal purposes.

Local Payments will come in two types, FIXED and VARIABLE. Fixed local payments have a set amount that must be paid, while variable local payments can vary based on certain conditions. Variable local payments will show non-null values for the minimum_amount and maximum_amount fields, while showing a null value for the amount field, indicating that the exact amount is not predetermined.

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_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

GET /local_payments/(string: local_payment_id)