Objects
Payment
A payment the agency has shown its client. Amounts are in minor units.
Attributes
object"payment"
idstring
Unique id of the payment.
trip_idstring
The trip it belongs to.
typeenum
What the payment is for.
depositbalancefulladd_ondescriptionstring or null
The concept the client reads, for example
Deposit.travelerobject or null
The traveller this share is for, by the name their trip page prints. Null for a payment of the whole trip.
+ Show 2 child attributes− Hide 2 child attributes
idstring
namestring
group_idstring or null
Shares of one payment split per person have the same group.
amountmoney
What the client has to pay, in minor units.
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
paidmoney
What the client has paid so far, in minor units.
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
outstandingmoney
What is still owed, in minor units.
+ Show 2 child attributes− Hide 2 child attributes
amountinteger
Integer minor units of the currency: 125000 EUR is €1,250.00.
currencystring
ISO 4217 code.
statusenum
paid when the amount is above zero and fully paid; due otherwise.paidduedue_datedate or null
When it is due.
YYYY-MM-DD.paid_atdate or null
The day the money landed, when known. Null while unpaid, and on some payments marked paid before this date was recorded.
YYYY-MM-DD.pay_urlstring or null
Where the client pays online. Null when nothing is owed, when the agency does not take card payments on this trip, or while a dispute blocks collection.
created_attimestamp
When it was created. ISO 8601, UTC.
updated_attimestamp
The last change to the payment itself. Use it with
updated_since to sync. A change to the trip's roster or to how the agency collects can change traveler.name or pay_url without moving it. ISO 8601, UTC.