Introduction
Transactions
Checkout Sessions
Payment links
Payment options
Refunds
Instruments
Vault
Connections
Other
using Gr4vy;
using Gr4vy.Models.Components;
var sdk = new Gr4vySDK(
id: "example",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
var res = await sdk.CheckoutSessions.UpdateAsync(
sessionId: "4137b1cf-39ac-42a8-bad6-1c680d5dab6b",
checkoutSessionCreate: new CheckoutSessionCreate() {}
);
// handle response{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "2023-11-07T05:31:56Z",
"cart_items": [
{
"name": "<string>",
"quantity": 123,
"unit_amount": 49999999,
"discount_amount": 0,
"tax_amount": 0,
"external_identifier": "goprohd",
"sku": "GPHD1078",
"upc": "012345678905",
"product_url": "https://example.com/catalog/go-pro-hd",
"image_url": "https://example.com/images/go-pro-hd.jpg",
"categories": [
"camera",
"travel",
"gear"
],
"product_type": "physical",
"seller_country": "US",
"tax_exempt": false,
"unit_of_measure": "feet",
"commodity_code": "43211503",
"description": "A brief description of an interesting item.",
"duty_amount": 1299,
"shipping_amount": 1299
}
],
"metadata": {
"cohort": "cohort-a",
"order_id": "order-12345"
},
"buyer": {
"display_name": "John Doe",
"external_identifier": "buyer-12345",
"billing_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
},
"tax_id": {
"value": "<string>",
"kind": "ae.trn"
}
},
"account_number": "<string>",
"shipping_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
}
}
},
"airline": {
"booking_code": "X36Q9C",
"is_cardholder_traveling": true,
"issued_address": "123 Broadway, New York",
"issued_at": "2013-07-16T19:23:00.000+00:00",
"issuing_carrier_code": "649",
"issuing_carrier_name": "Air Transat A.T. Inc",
"issuing_iata_designator": "TS",
"issuing_icao_code": "TSC",
"legs": [
{
"arrival_airport": "LAX",
"arrival_at": "2013-07-16T19:23:00.000+00:00",
"arrival_city": "Los Angeles",
"arrival_country": "US",
"carrier_code": "649",
"carrier_name": "Air Transat A.T. Inc",
"iata_designator": "TS",
"icao_code": "TSC",
"coupon_number": "15885566",
"departure_airport": "LHR",
"departure_at": "2013-07-16T19:23:00.000+00:00",
"departure_city": "London",
"departure_country": "GB",
"departure_tax_amount": 1200,
"fare_amount": 129900,
"fare_basis_code": "FY",
"fee_amount": 1200,
"flight_class": "E",
"flight_number": "101",
"route_type": "round_trip",
"seat_class": "F",
"stop_over": false,
"tax_amount": 1200
}
],
"passenger_name_record": "JOHN L",
"passengers": [
{
"age_group": "adult",
"date_of_birth": "2013-07-16",
"email_address": "[email protected]",
"first_name": "John",
"frequent_flyer_number": "15885566",
"last_name": "Luhn",
"passport_number": "11117700225",
"phone_number": "+1234567890",
"ticket_number": "BA1236699999",
"title": "Mr.",
"country_code": "US"
}
],
"reservation_system": "Amadeus",
"restricted_ticket": false,
"ticket_delivery_method": "electronic",
"ticket_number": "123-1234-151555",
"travel_agency_code": "12345",
"travel_agency_invoice_number": "EG15555155",
"travel_agency_name": "ACME Agency",
"travel_agency_plan_name": "B733"
},
"type": "checkout-session",
"payment_method": {
"type": "payment-method",
"id": "ef9496d8-53a5-4aad-8ca2-00eb68334389",
"details": {
"bin": "411111",
"card_country": "US",
"card_type": "credit",
"card_issuer_name": "Bank of America NA"
},
"label": "1234",
"method": "card",
"scheme": "visa",
"fingerprint": "a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"
}
}Update checkout session
Update the information stored on a checkout session.
using Gr4vy;
using Gr4vy.Models.Components;
var sdk = new Gr4vySDK(
id: "example",
server: SDKConfig.Server.Sandbox,
bearerAuthSource: Auth.WithToken(privateKey),
merchantAccountId: "default"
);
var res = await sdk.CheckoutSessions.UpdateAsync(
sessionId: "4137b1cf-39ac-42a8-bad6-1c680d5dab6b",
checkoutSessionCreate: new CheckoutSessionCreate() {}
);
// handle response{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expires_at": "2023-11-07T05:31:56Z",
"cart_items": [
{
"name": "<string>",
"quantity": 123,
"unit_amount": 49999999,
"discount_amount": 0,
"tax_amount": 0,
"external_identifier": "goprohd",
"sku": "GPHD1078",
"upc": "012345678905",
"product_url": "https://example.com/catalog/go-pro-hd",
"image_url": "https://example.com/images/go-pro-hd.jpg",
"categories": [
"camera",
"travel",
"gear"
],
"product_type": "physical",
"seller_country": "US",
"tax_exempt": false,
"unit_of_measure": "feet",
"commodity_code": "43211503",
"description": "A brief description of an interesting item.",
"duty_amount": 1299,
"shipping_amount": 1299
}
],
"metadata": {
"cohort": "cohort-a",
"order_id": "order-12345"
},
"buyer": {
"display_name": "John Doe",
"external_identifier": "buyer-12345",
"billing_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
},
"tax_id": {
"value": "<string>",
"kind": "ae.trn"
}
},
"account_number": "<string>",
"shipping_details": {
"first_name": "John",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": "+1234567890",
"address": {
"city": "San Jose",
"country": "US",
"postal_code": "94560",
"state": "California",
"state_code": "US-CA",
"house_number_or_name": "10",
"line1": "Stafford Appartments",
"line2": "29th Street",
"organization": "Gr4vy"
}
}
},
"airline": {
"booking_code": "X36Q9C",
"is_cardholder_traveling": true,
"issued_address": "123 Broadway, New York",
"issued_at": "2013-07-16T19:23:00.000+00:00",
"issuing_carrier_code": "649",
"issuing_carrier_name": "Air Transat A.T. Inc",
"issuing_iata_designator": "TS",
"issuing_icao_code": "TSC",
"legs": [
{
"arrival_airport": "LAX",
"arrival_at": "2013-07-16T19:23:00.000+00:00",
"arrival_city": "Los Angeles",
"arrival_country": "US",
"carrier_code": "649",
"carrier_name": "Air Transat A.T. Inc",
"iata_designator": "TS",
"icao_code": "TSC",
"coupon_number": "15885566",
"departure_airport": "LHR",
"departure_at": "2013-07-16T19:23:00.000+00:00",
"departure_city": "London",
"departure_country": "GB",
"departure_tax_amount": 1200,
"fare_amount": 129900,
"fare_basis_code": "FY",
"fee_amount": 1200,
"flight_class": "E",
"flight_number": "101",
"route_type": "round_trip",
"seat_class": "F",
"stop_over": false,
"tax_amount": 1200
}
],
"passenger_name_record": "JOHN L",
"passengers": [
{
"age_group": "adult",
"date_of_birth": "2013-07-16",
"email_address": "[email protected]",
"first_name": "John",
"frequent_flyer_number": "15885566",
"last_name": "Luhn",
"passport_number": "11117700225",
"phone_number": "+1234567890",
"ticket_number": "BA1236699999",
"title": "Mr.",
"country_code": "US"
}
],
"reservation_system": "Amadeus",
"restricted_ticket": false,
"ticket_delivery_method": "electronic",
"ticket_number": "123-1234-151555",
"travel_agency_code": "12345",
"travel_agency_invoice_number": "EG15555155",
"travel_agency_name": "ACME Agency",
"travel_agency_plan_name": "B733"
},
"type": "checkout-session",
"payment_method": {
"type": "payment-method",
"id": "ef9496d8-53a5-4aad-8ca2-00eb68334389",
"details": {
"bin": "411111",
"card_country": "US",
"card_type": "credit",
"card_issuer_name": "Bank of America NA"
},
"label": "1234",
"method": "card",
"scheme": "visa",
"fingerprint": "a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"
}
}checkout-sessions.write scope.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the merchant account to use for this request.
Path Parameters
The ID of the checkout session.
Body
An array of cart items that represents the line items of a transaction.
Show child attributes
Show child attributes
The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.
1 - 255The quantity of this item in the cart. This value cannot be negative or zero.
x <= 99999999The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.
0 <= x <= 99999999The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.
0 <= x <= 999999990
The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.
0 <= x <= 999999990
An external identifier for the cart item. This can be set to any value and is not sent to the payment service.
1 - 200"goprohd"
The SKU or product code for the item.
1 - 200"GPHD1078"
The UPC for the item.
1 - 50"012345678905"
The product URL for the item.
"https://example.com/catalog/go-pro-hd"
The URL for the image of the item.
"https://example.com/images/go-pro-hd.jpg"
A list of strings containing product categories for the item.
1 - 50["camera", "travel", "gear"]The product type of the cart item.
physical, discount, shipping_fee, sales_tax, digital, gift_card, store_credit, surcharge "physical"
The seller country of the cart item.
"US"
Whether the item is exempt of tax.
false
The unit of measure or the unit of measure code.
1 - 50"feet"
Item commodity code. Generally a UNSPSC code.
1 - 50"43211503"
Brief item description.
1 - 255"A brief description of an interesting item."
Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99
0 <= x <= 999999991299
Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99
0 <= x <= 999999991299
Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.
Show child attributes
Show child attributes
The display name for the buyer.
1 - 200"John Doe"
The merchant identifier for this buyer.
1 - 200"buyer-12345"
The billing name, address, email, and other fields for this buyer.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The tax ID information associated with the billing details.
Show child attributes
Show child attributes
The tax ID for the buyer.
1 - 50The kind of tax ID
ae.trn, au.abn, ar.dni, ar.cuil, ar.cuit, br.cnpj, br.cpf, ca.bn, ca.gst_hst, ca.pst_bc, ca.pst_mb, ca.pst_sk, ca.qst, ch.vat, cl.tin, co.itin, co.nit, es.cif, eu.vat, gb.vat, hk.br, id.nik, id.npwp, in.gst, in.pan, jp.cn, jp.rn, kr.brn, li.uid, mx.curp, mx.rfc, my.frp, my.itn, my.nric, my.sst, no.vat, nz.gst, pe.ruc, ph.tin, ru.inn, ru.kpp, sa.vat, sg.gst, sg.uen, th.id, th.vat, tw.vat, us.ein, za.vat, bo.ci, uy.rut, uy.ci The buyer account number
1 - 200The optional shipping details for this buyer.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The airline addendum data which describes the airline booking associated with this transaction.
Show child attributes
Show child attributes
The unique identifier of the reservation in the global distribution system.
1 - 50"X36Q9C"
Indicates whether the cardholder is traveling.
true
The address of the place/agency that issued the ticket.
1 - 255"123 Broadway, New York"
The date that the ticket was last issued in the airline reservation system.
"2013-07-16T19:23:00.000+00:00"
For airline aggregators, three-character IATA code of the airline issuing the ticket.
2 - 3"649"
For airline aggregators, name of the airline issuing the ticket.
1"Air Transat A.T. Inc"
For airline aggregators, two-character IATA code of the airline issuing the ticket.
2"TS"
For airline aggregators, three-character ICAO code of the airline issuing the ticket.
3"TSC"
An array of separate trip segments. Each leg contains detailed itinerary information.
20Show child attributes
Show child attributes
Arrival airport code of leg. 3-letter ISO code according to IATA official directory.
3"LAX"
The date and time of travel in local time at the arrival airport.
"2013-07-16T19:23:00.000+00:00"
Arrival city name.
1 - 100"Los Angeles"
Arrival country code in ISO 3166 format.
"US"
3 character airline code as set by IATA.
2 - 3"649"
Name of the airline.
1"Air Transat A.T. Inc"
Two-character IATA code of the airline.
2"TS"
Three-character ICAO code of the airline.
3"TSC"
Coupon number associated with the leg.
1 - 50"15885566"
Departure airport code of leg. 3-letter ISO code according to IATA official directory.
3"LHR"
The date and time of travel in local time at the departure airport.
"2013-07-16T19:23:00.000+00:00"
Departure city name.
1 - 100"London"
Departure airport code of leg. 3-letter ISO code according to IATA official directory.
"GB"
Departure tax amount charged by a country when a person is leaving the country.
0 <= x <= 999999991200
Amount of the ticket, for current leg of the trip, excluding taxes and fees.
0 <= x <= 99999999129900
The alphanumeric code for the booking class of a ticket.
1 - 8"FY"
Fee amount for current leg of the trip.
0 <= x <= 999999991200
Indicates service class (first class, business class, etc.).
1 - 5"E"
Unique identifier of the flight number.
3 - 6"101"
The route type of the flight.
round_trip, one_way "round_trip"
Indicates seat class (first class, business class, etc.).
1 - 5"F"
Indicates whether a stopover is allowed on this ticket.
false
Amount of the taxes for current leg of the trip.
0 <= x <= 999999991200
The Passenger Name Record (PNR) in the airline reservation system.
1 - 50"JOHN L"
An array of the travelling passengers.
20Show child attributes
Show child attributes
The age group for the passenger.
adult, infant "adult"
The passenger's date of birth in YYYY-MM-YY format.
"2013-07-16"
The first name(s) or given name of the passenger.
1 - 255"John"
The passenger's frequent flyer number.
5 - 50"15885566"
The last name, or family name, of the passenger.
1 - 255"Luhn"
The passenger's unique passport number.
1 - 50"11117700225"
The phone number of the passenger. This number is formatted according to the E164 number standard.
"+1234567890"
The ticket number for a flight.
1 - 50"BA1236699999"
Title of the passenger.
1 - 50"Mr."
The country of residence of the passenger
"US"
The name of the reservation system.
1 - 200"Amadeus"
Indicates whether the ticket is restricted (refundable).
false
The delivery method of the ticket.
electronic, other "electronic"
The airline's unique ticket number.
1 - 50"123-1234-151555"
The IATA travel agency code.
1 - 50"12345"
The reference number of the invoice that was issued by the travel agency.
1 - 50"EG15555155"
The name of the travel agency.
1 - 200"ACME Agency"
The name of the travel agency plan.
1 - 200"B733"
The time in seconds when this checkout session expires.
3600 <= x <= 86400Response
Successful Response
The ID for the checkout session.
The date and time when this checkout session expires.
An array of cart items that represents the line items of a transaction.
Show child attributes
Show child attributes
The name of the cart item. The value you set for this property may be truncated if the maximum length accepted by a payment service provider is less than 255 characters.
1 - 255The quantity of this item in the cart. This value cannot be negative or zero.
x <= 99999999The amount for an individual item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99. The amount sent through to the payment processor as unitary amount will be calculated to include the discount and tax values sent as part of this cart item.
0 <= x <= 99999999The amount discounted for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.
0 <= x <= 999999990
The tax amount for this item represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 USD cents represents $12.99.
0 <= x <= 999999990
An external identifier for the cart item. This can be set to any value and is not sent to the payment service.
1 - 200"goprohd"
The SKU or product code for the item.
1 - 200"GPHD1078"
The UPC for the item.
1 - 50"012345678905"
The product URL for the item.
"https://example.com/catalog/go-pro-hd"
The URL for the image of the item.
"https://example.com/images/go-pro-hd.jpg"
A list of strings containing product categories for the item.
1 - 50["camera", "travel", "gear"]The product type of the cart item.
physical, discount, shipping_fee, sales_tax, digital, gift_card, store_credit, surcharge "physical"
The seller country of the cart item.
"US"
Whether the item is exempt of tax.
false
The unit of measure or the unit of measure code.
1 - 50"feet"
Item commodity code. Generally a UNSPSC code.
1 - 50"43211503"
Brief item description.
1 - 255"A brief description of an interesting item."
Item import or export duties represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99
0 <= x <= 999999991299
Freight/shipping amount represented as a monetary amount in the smallest currency unit for the given currency, for example 1299 cents to create an authorization for $12.99
0 <= x <= 999999991299
Provide buyer details for the transaction. No buyer resource will be created on Gr4vy when used.
Show child attributes
Show child attributes
The display name for the buyer.
1 - 200"John Doe"
The merchant identifier for this buyer.
1 - 200"buyer-12345"
The billing name, address, email, and other fields for this buyer.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The tax ID information associated with the billing details.
Show child attributes
Show child attributes
The tax ID for the buyer.
1 - 50The kind of tax ID
ae.trn, au.abn, ar.dni, ar.cuil, ar.cuit, br.cnpj, br.cpf, ca.bn, ca.gst_hst, ca.pst_bc, ca.pst_mb, ca.pst_sk, ca.qst, ch.vat, cl.tin, co.itin, co.nit, es.cif, eu.vat, gb.vat, hk.br, id.nik, id.npwp, in.gst, in.pan, jp.cn, jp.rn, kr.brn, li.uid, mx.curp, mx.rfc, my.frp, my.itn, my.nric, my.sst, no.vat, nz.gst, pe.ruc, ph.tin, ru.inn, ru.kpp, sa.vat, sg.gst, sg.uen, th.id, th.vat, tw.vat, us.ein, za.vat, bo.ci, uy.rut, uy.ci The buyer account number
1 - 200The optional shipping details for this buyer.
Show child attributes
Show child attributes
The first name(s) or given name for the buyer.
1 - 255"John"
The last name, or family name, of the buyer.
1 - 255"Doe"
The phone number for the buyer which should be formatted according to the E164 number standard.
"+1234567890"
The billing address for the buyer.
Show child attributes
Show child attributes
The city for the address.
1 - 100"San Jose"
The country for the address in ISO 3166 format.
"US"
The postal code or zip code for the address.
1 - 50"94560"
The state, county, or province for the address.
1 - 255"California"
The code of state, county, or province for the address in ISO 3166-2 format.
"US-CA"
The house number or name for the address. Not all payment services use this field but some do.
1 - 255"10"
The first line of the address.
1 - 255"Stafford Appartments"
The second line of the address.
1 - 255"29th Street"
The optional name of the company or organisation to add to the address.
1 - 255"Gr4vy"
The airline addendum data which describes the airline booking associated with this transaction.
Show child attributes
Show child attributes
The unique identifier of the reservation in the global distribution system.
1 - 50"X36Q9C"
Indicates whether the cardholder is traveling.
true
The address of the place/agency that issued the ticket.
1 - 255"123 Broadway, New York"
The date that the ticket was last issued in the airline reservation system.
"2013-07-16T19:23:00.000+00:00"
For airline aggregators, three-character IATA code of the airline issuing the ticket.
2 - 3"649"
For airline aggregators, name of the airline issuing the ticket.
1"Air Transat A.T. Inc"
For airline aggregators, two-character IATA code of the airline issuing the ticket.
2"TS"
For airline aggregators, three-character ICAO code of the airline issuing the ticket.
3"TSC"
An array of separate trip segments. Each leg contains detailed itinerary information.
20Show child attributes
Show child attributes
Arrival airport code of leg. 3-letter ISO code according to IATA official directory.
3"LAX"
The date and time of travel in local time at the arrival airport.
"2013-07-16T19:23:00.000+00:00"
Arrival city name.
1 - 100"Los Angeles"
Arrival country code in ISO 3166 format.
"US"
3 character airline code as set by IATA.
2 - 3"649"
Name of the airline.
1"Air Transat A.T. Inc"
Two-character IATA code of the airline.
2"TS"
Three-character ICAO code of the airline.
3"TSC"
Coupon number associated with the leg.
1 - 50"15885566"
Departure airport code of leg. 3-letter ISO code according to IATA official directory.
3"LHR"
The date and time of travel in local time at the departure airport.
"2013-07-16T19:23:00.000+00:00"
Departure city name.
1 - 100"London"
Departure airport code of leg. 3-letter ISO code according to IATA official directory.
"GB"
Departure tax amount charged by a country when a person is leaving the country.
0 <= x <= 999999991200
Amount of the ticket, for current leg of the trip, excluding taxes and fees.
0 <= x <= 99999999129900
The alphanumeric code for the booking class of a ticket.
1 - 8"FY"
Fee amount for current leg of the trip.
0 <= x <= 999999991200
Indicates service class (first class, business class, etc.).
1 - 5"E"
Unique identifier of the flight number.
3 - 6"101"
The route type of the flight.
round_trip, one_way "round_trip"
Indicates seat class (first class, business class, etc.).
1 - 5"F"
Indicates whether a stopover is allowed on this ticket.
false
Amount of the taxes for current leg of the trip.
0 <= x <= 999999991200
The Passenger Name Record (PNR) in the airline reservation system.
1 - 50"JOHN L"
An array of the travelling passengers.
20Show child attributes
Show child attributes
The age group for the passenger.
adult, infant "adult"
The passenger's date of birth in YYYY-MM-YY format.
"2013-07-16"
The first name(s) or given name of the passenger.
1 - 255"John"
The passenger's frequent flyer number.
5 - 50"15885566"
The last name, or family name, of the passenger.
1 - 255"Luhn"
The passenger's unique passport number.
1 - 50"11117700225"
The phone number of the passenger. This number is formatted according to the E164 number standard.
"+1234567890"
The ticket number for a flight.
1 - 50"BA1236699999"
Title of the passenger.
1 - 50"Mr."
The country of residence of the passenger
"US"
The name of the reservation system.
1 - 200"Amadeus"
Indicates whether the ticket is restricted (refundable).
false
The delivery method of the ticket.
electronic, other "electronic"
The airline's unique ticket number.
1 - 50"123-1234-151555"
The IATA travel agency code.
1 - 50"12345"
The reference number of the invoice that was issued by the travel agency.
1 - 50"EG15555155"
The name of the travel agency.
1 - 200"ACME Agency"
The name of the travel agency plan.
1 - 200"B733"
Always checkout-session
"checkout-session"Information about the payment method stored on the checkout session.
Show child attributes
Show child attributes
Always payment-method
"payment-method"The ID of the payment method.
"ef9496d8-53a5-4aad-8ca2-00eb68334389"
Details for credit or debit card payment method.
Show child attributes
Show child attributes
The first 6 digit of the card.
"411111"
The country of the card issuer.
"US"
The payment scheme of the card.
credit, debit, prepaid "credit"
The card issuer.
"Bank of America NA"
The last 4 digits of the the card.
"1234"
Always card
"card"The scheme of the card.
accel, amex, bancontact, carte-bancaire, cirrus, culiance, dankort, diners-club, discover, eftpos-australia, elo, hipercard, jcb, maestro, mastercard, mir, nyce, other, pulse, rupay, star, uatp, unionpay, visa "visa"
The unique hash derived from the card number.
"a50b85c200ee0795d6fd33a5c66f37a4564f554355c5b46a756aac485dd168a4"
Was this page helpful?