Purchase Gap Medical
POST/v1/purchase/gap-medical
Purchase Gap Medical
Request
- application/json
Body
required
customer object
2-character state code. Either state or postal_code is required when requesting a quote.
Possible values: >= 2 characters
and <= 2 characters
, [US
, CA
]
Default value: US
2-character country code
Either state or postal_code is required when requesting a quote.
metadata object
payment_method objectrequired
Only one of a card
, bank_account
or token
payment is required.
card object
Name on card.
Number on card.
Verification code (CVV).
Month as a number string (e.g. August would be either "08" or "8").
Year as a string (e.g. "2023", i.e. YYYY).
Just the postal code (e.g. 04951).
bank_account object
Store the payment information for use in the future.
The quote id to purchase
Responses
- 201
- 400
- 402
New policy issued
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
policy_holder object
customer object
state_object object
state object
Possible values: >= 50
The premium amount of the policy. This is typically considered a sub-total. Use total
for charging payment methods and displaying amounts to the user.
policy_documents object[]
Possible values: [POLICY
, CERTIFICATE_OF_INSURANCE
, OTHER
]
Possible values: [ACTIVE
, QUOTED
, EXPIRED
, PENDING_CANCELLATION
, CANCELED
, PENDING
, REQUIRES_PAYMENT
, BIND_FAILED
]
product object
Possible values: [event-participation-cancellation-insurance
, event-host-liability
, event-host-cancellation
, pet-insurance
, shipping
, collectibles
, medsaver
, gap-medical
, regsaver
, travel
, tuition
, registration-cancellation
, ticket-refund
, season-interruption
, team-registration
]
policy_attributes object
Cache the value of covered sport since it's called twice every request and is expensive to calculate.
covered_person objectrequired
Possible values: >= 2 characters
and <= 2 characters
Covered person's state residence (e.g. "MI", for Michigan)
Possible values: >= 2 characters
and <= 2 characters
contacts object[]
Possible values: [ACADEMIC_CLUB
, AEROBICS
, ARCHERY
, ART
, BADMINTON
, BAND
, BARRE
, BASEBALL
, BASKETBALL
, BOCCE
, BOOTCAMP_CLASS
, BOWLING
, BOXING
, BUBBLE_BALL_SOCCER
, CHESS
, CHORUS
, COMPETITIVE_CHEERLEADING
, CREW
, CRICKET
, CROSSFIT
, CROSS_COUNTRY
, CROSS_COUNTRY_SKIING
, CURLING
, DANCE
, DEBATE
, DIVING
, DOCK_DOGS
, DOWNHILL_SKIING
, DRAMA
, EXERCISE_BIKE
, E_SPORTS
, FENCING
, FIELD_HOCKEY
, FIGURE_SKATING
, FISHING
, FITNESS_CENTERS
, FLAG_FOOTBALL
, FOOTBALL
, GOLF
, GYMNASTICS
, HANDBALL
, HIIT
, HIKING
, ICE_HOCKEY
, ICE_SKATING
, INLINE_SKATING
, JAI_ALAI
, JUDO
, KARATE
, KICKBALL
, KICKBOXING
, LACROSSE
, MARCHING_BAND
, MARTIAL_ARTS
, MEDITATION
, MODEL_UN
, MUD_RUN
, MUSIC
, ORIENTEERING
, PADDLEBALL
, PAINTBALL
, PERSONAL_TRAINING
, POLO
, RACQUETBALL
, REFEREEING
, RIFLERY
, ROAD_CYCLING
, ROBOTICS
, ROCK_CLIMBING
, ROWING
, RUGBY
, SAILING
, SIDELINE_CHEERLEADING
, SKIING
, SKI_CLUB
, SNOW_SHOE
, SOCCER
, SOFTBALL
, SPARTAN_RACE
, SQUASH
, STREET_HOCKEY
, STUDENT_GOVERMENT
, SWIMMING
, TAI_CHI
, TEE_BALL
, TENNIS
, THEATER
, TRACK
, TRACK_AND_FIELD
, TRIATHLON
, ULTIMATE_FRISBEE
, VOLLEYBALL
, WALKING
, WATER_POLO
, WEIGHT_LIFTING
, WRESTLING
, YOGA
]
subscription_premium object
If this policy supports being billed as a monthly subscription instead of a one-time fee, this field will be present
The number of monthly payments required for this subscription
The monthly premium to be paid for this subscription
Possible values: [USD
, CAD
]
Total cost of the policy in cents. This is the amount that should be displayed and charged during checkout if the user accepts the insurance purchase.
taxes_and_fees object[]
Possible values: [fee
, tax
]
metadata object
{
"policy_holder": {
"first_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"customer": {
"email_address": "user@example.com"
},
"street": "string",
"city": "string",
"state_object": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string"
},
"state": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string"
},
"postal_code": "string",
"country": "string"
},
"premium_amount": 0,
"policy_number": "string",
"policy_documents": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"master_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "POLICY",
"storage_bucket": "string",
"storage_key": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2024-05-16T17:44:31.050Z",
"expiration_date": "string",
"effective_date": "string",
"quote_date": "2024-05-16T17:44:31.050Z",
"product": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_icon": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string"
},
"policy_attributes": {
"covered_sport": "string",
"covered_person": {
"state": "MN",
"first_name": "string",
"last_name": "string",
"street": "string",
"country": "string",
"birth_date": "2024-05-16",
"contacts": [
{
"first_name": "string",
"last_name": "string",
"street": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
]
},
"coverage_start_date": "2024-05-16",
"coverage_end_date": "2024-05-16",
"coverage_type": "ACADEMIC_CLUB"
},
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0
},
"currency": "USD",
"total": 0,
"taxes_and_fees": [
{
"amount": 0,
"description": "string",
"type": "fee"
}
],
"quote_id": "string",
"is_test": true,
"metadata": {},
"checkout_url": "string"
}
Bad request was sent, most likely from a missing parameter.
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string",
"message": "string",
"status": 0
}
Failed payment
- application/json
- Schema
- Example (from schema)
Schema
{
"error": "string",
"error_code": "string",
"message": "string",
"status": 0
}