Skip to content

Tirth API · Reference

API reference

Every v2 operation, drawn from the OpenAPI 3.1 file this site serves. Send your secret key as a Bearer token: each operation names the scope the key needs.

Hosts

Sandbox
https://sandbox.api.tirth.com
Live
https://api.tirth.com

Paths start with /v2. Test keys work only in the sandbox, and live keys only in production.

Every operation can also answer

  • validation_failed400
  • unauthenticated401
  • forbidden403
  • rate_limited429
  • internal500
  • unavailable503

Every error is the same envelope: code, message, field and request_id. Read what each code means

Catalogue

9 operations

GET /v2/pujas

List live pujas, a page at a time, or those changed since a moment.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • updated_sincequerystring

    format date-time

  • cursorquerystring

    1 characters or more · up to 40 characters

  • limitqueryinteger

    at least 1 · at most 50 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

    • kindstringrequired

      one of puja, samuhik_puja, package

    • namestringrequired

    • summarystringrequired

    • performed_atobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • cityobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • placesarray of objectrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • booking_typestringrequired

      one of instant, on_request

    • solemnbooleanrequired

    • durationobjectrequired

      • minutesinteger or nullrequired

        more than 0

      • daysinteger or nullrequired

        more than 0

      • nightsinteger or nullrequired

        at least 0

    • variantsarray of objectrequired

      1 items or more

      • idstringrequired

        pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

      • namestringrequired

      • max_namesinteger or nullrequired

        more than 0

      • optionsmap of stringrequired

        keys take_part, stay, meals, vehicle, size

    • inclusionsarray of stringrequired

    • exclusionsarray of stringrequired

    • what_you_receivearray of stringrequired

    • add_on_idsarray of stringrequired

    • cancellation_policyobject or nullrequired

      • namestringrequired

      • bandsarray of objectrequired

        • hours_before_startintegerrequired

          at least 0

        • charge_bpintegerrequired

          at least 0 · at most 10000

    • imagesarray of objectrequired

      • urlstringrequired

        format uri

      • altstringrequired

      • creditstringrequired

      • widthintegerrequired

      • heightintegerrequired

    • reference_priceobject or nullrequired

      • amount_paiseintegerrequired

      • unitstringrequired

        one of per_person, per_group, per_family, per_room, per_vehicle, total

      • gststringrequired

        one of included, none

      • labelstringrequired

    • page_urlstringrequired

      format uri

    • checked_onstringrequired

      format date

    • updated_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

GET /v2/pujas/{id}

Read one puja.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • idpathstringrequired

    pattern ^pj_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • kindstringrequired

    one of puja, samuhik_puja, package

  • namestringrequired

  • summarystringrequired

  • performed_atobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • cityobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • placesarray of objectrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • booking_typestringrequired

    one of instant, on_request

  • solemnbooleanrequired

  • durationobjectrequired

    • minutesinteger or nullrequired

      more than 0

    • daysinteger or nullrequired

      more than 0

    • nightsinteger or nullrequired

      at least 0

  • variantsarray of objectrequired

    1 items or more

    • idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • namestringrequired

    • max_namesinteger or nullrequired

      more than 0

    • optionsmap of stringrequired

      keys take_part, stay, meals, vehicle, size

  • inclusionsarray of stringrequired

  • exclusionsarray of stringrequired

  • what_you_receivearray of stringrequired

  • add_on_idsarray of stringrequired

  • cancellation_policyobject or nullrequired

    • namestringrequired

    • bandsarray of objectrequired

      • hours_before_startintegerrequired

        at least 0

      • charge_bpintegerrequired

        at least 0 · at most 10000

  • imagesarray of objectrequired

    • urlstringrequired

      format uri

    • altstringrequired

    • creditstringrequired

    • widthintegerrequired

    • heightintegerrequired

  • reference_priceobject or nullrequired

    • amount_paiseintegerrequired

    • unitstringrequired

      one of per_person, per_group, per_family, per_room, per_vehicle, total

    • gststringrequired

      one of included, none

    • labelstringrequired

  • page_urlstringrequired

    format uri

  • checked_onstringrequired

    format date

  • updated_atstringrequired

    format date-time

Its own error codes

  • not_found404

GET /v2/samuhik-pujas

List live samuhik pujas, a page at a time.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • updated_sincequerystring

    format date-time

  • cursorquerystring

    1 characters or more · up to 40 characters

  • limitqueryinteger

    at least 1 · at most 50 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

    • kindstringrequired

      one of puja, samuhik_puja, package

    • namestringrequired

    • summarystringrequired

    • performed_atobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • cityobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • placesarray of objectrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • booking_typestringrequired

      one of instant, on_request

    • solemnbooleanrequired

    • durationobjectrequired

      • minutesinteger or nullrequired

        more than 0

      • daysinteger or nullrequired

        more than 0

      • nightsinteger or nullrequired

        at least 0

    • variantsarray of objectrequired

      1 items or more

      • idstringrequired

        pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

      • namestringrequired

      • max_namesinteger or nullrequired

        more than 0

      • optionsmap of stringrequired

        keys take_part, stay, meals, vehicle, size

    • inclusionsarray of stringrequired

    • exclusionsarray of stringrequired

    • what_you_receivearray of stringrequired

    • add_on_idsarray of stringrequired

    • cancellation_policyobject or nullrequired

      • namestringrequired

      • bandsarray of objectrequired

        • hours_before_startintegerrequired

          at least 0

        • charge_bpintegerrequired

          at least 0 · at most 10000

    • imagesarray of objectrequired

      • urlstringrequired

        format uri

      • altstringrequired

      • creditstringrequired

      • widthintegerrequired

      • heightintegerrequired

    • reference_priceobject or nullrequired

      • amount_paiseintegerrequired

      • unitstringrequired

        one of per_person, per_group, per_family, per_room, per_vehicle, total

      • gststringrequired

        one of included, none

      • labelstringrequired

    • page_urlstringrequired

      format uri

    • checked_onstringrequired

      format date

    • updated_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

GET /v2/samuhik-pujas/{id}

Read one samuhik puja.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • idpathstringrequired

    pattern ^sp_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • kindstringrequired

    one of puja, samuhik_puja, package

  • namestringrequired

  • summarystringrequired

  • performed_atobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • cityobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • placesarray of objectrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • booking_typestringrequired

    one of instant, on_request

  • solemnbooleanrequired

  • durationobjectrequired

    • minutesinteger or nullrequired

      more than 0

    • daysinteger or nullrequired

      more than 0

    • nightsinteger or nullrequired

      at least 0

  • variantsarray of objectrequired

    1 items or more

    • idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • namestringrequired

    • max_namesinteger or nullrequired

      more than 0

    • optionsmap of stringrequired

      keys take_part, stay, meals, vehicle, size

  • inclusionsarray of stringrequired

  • exclusionsarray of stringrequired

  • what_you_receivearray of stringrequired

  • add_on_idsarray of stringrequired

  • cancellation_policyobject or nullrequired

    • namestringrequired

    • bandsarray of objectrequired

      • hours_before_startintegerrequired

        at least 0

      • charge_bpintegerrequired

        at least 0 · at most 10000

  • imagesarray of objectrequired

    • urlstringrequired

      format uri

    • altstringrequired

    • creditstringrequired

    • widthintegerrequired

    • heightintegerrequired

  • reference_priceobject or nullrequired

    • amount_paiseintegerrequired

    • unitstringrequired

      one of per_person, per_group, per_family, per_room, per_vehicle, total

    • gststringrequired

      one of included, none

    • labelstringrequired

  • page_urlstringrequired

    format uri

  • checked_onstringrequired

    format date

  • updated_atstringrequired

    format date-time

Its own error codes

  • not_found404

GET /v2/packages

List live yatra packages, a page at a time.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • updated_sincequerystring

    format date-time

  • cursorquerystring

    1 characters or more · up to 40 characters

  • limitqueryinteger

    at least 1 · at most 50 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

    • kindstringrequired

      one of puja, samuhik_puja, package

    • namestringrequired

    • summarystringrequired

    • performed_atobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • cityobject or nullrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • placesarray of objectrequired

      • idstringrequired

        pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

      • namestringrequired

    • booking_typestringrequired

      one of instant, on_request

    • solemnbooleanrequired

    • durationobjectrequired

      • minutesinteger or nullrequired

        more than 0

      • daysinteger or nullrequired

        more than 0

      • nightsinteger or nullrequired

        at least 0

    • variantsarray of objectrequired

      1 items or more

      • idstringrequired

        pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

      • namestringrequired

      • max_namesinteger or nullrequired

        more than 0

      • optionsmap of stringrequired

        keys take_part, stay, meals, vehicle, size

    • inclusionsarray of stringrequired

    • exclusionsarray of stringrequired

    • what_you_receivearray of stringrequired

    • add_on_idsarray of stringrequired

    • cancellation_policyobject or nullrequired

      • namestringrequired

      • bandsarray of objectrequired

        • hours_before_startintegerrequired

          at least 0

        • charge_bpintegerrequired

          at least 0 · at most 10000

    • imagesarray of objectrequired

      • urlstringrequired

        format uri

      • altstringrequired

      • creditstringrequired

      • widthintegerrequired

      • heightintegerrequired

    • reference_priceobject or nullrequired

      • amount_paiseintegerrequired

      • unitstringrequired

        one of per_person, per_group, per_family, per_room, per_vehicle, total

      • gststringrequired

        one of included, none

      • labelstringrequired

    • page_urlstringrequired

      format uri

    • checked_onstringrequired

      format date

    • updated_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

GET /v2/packages/{id}

Read one yatra package.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • idpathstringrequired

    pattern ^pkg_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • kindstringrequired

    one of puja, samuhik_puja, package

  • namestringrequired

  • summarystringrequired

  • performed_atobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • cityobject or nullrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • placesarray of objectrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • booking_typestringrequired

    one of instant, on_request

  • solemnbooleanrequired

  • durationobjectrequired

    • minutesinteger or nullrequired

      more than 0

    • daysinteger or nullrequired

      more than 0

    • nightsinteger or nullrequired

      at least 0

  • variantsarray of objectrequired

    1 items or more

    • idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • namestringrequired

    • max_namesinteger or nullrequired

      more than 0

    • optionsmap of stringrequired

      keys take_part, stay, meals, vehicle, size

  • inclusionsarray of stringrequired

  • exclusionsarray of stringrequired

  • what_you_receivearray of stringrequired

  • add_on_idsarray of stringrequired

  • cancellation_policyobject or nullrequired

    • namestringrequired

    • bandsarray of objectrequired

      • hours_before_startintegerrequired

        at least 0

      • charge_bpintegerrequired

        at least 0 · at most 10000

  • imagesarray of objectrequired

    • urlstringrequired

      format uri

    • altstringrequired

    • creditstringrequired

    • widthintegerrequired

    • heightintegerrequired

  • reference_priceobject or nullrequired

    • amount_paiseintegerrequired

    • unitstringrequired

      one of per_person, per_group, per_family, per_room, per_vehicle, total

    • gststringrequired

      one of included, none

    • labelstringrequired

  • page_urlstringrequired

    format uri

  • checked_onstringrequired

    format date

  • updated_atstringrequired

    format date-time

Its own error codes

  • not_found404

GET /v2/add-ons

List the add-ons products may be sold with.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • updated_sincequerystring

    format date-time

  • cursorquerystring

    1 characters or more · up to 40 characters

  • limitqueryinteger

    at least 1 · at most 50 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^ad_[0-9A-HJKMNP-TV-Z]{26}$

    • namestringrequired

    • unitstring or nullrequired

      one of per_person, per_group, per_booking

    • product_idsarray of stringrequired

    • updated_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

GET /v2/add-ons/{id}

Read one add-on.

  • Scopecatalogue:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • idpathstringrequired

    pattern ^ad_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^ad_[0-9A-HJKMNP-TV-Z]{26}$

  • namestringrequired

  • unitstring or nullrequired

    one of per_person, per_group, per_booking

  • product_idsarray of stringrequired

  • updated_atstringrequired

    format date-time

Its own error codes

  • not_found404

Availability

5 operations

GET /v2/pujas/{id}/availability

A puja's dates and time windows that can be booked.

  • Scopeavailability:read
  • Rate-limit group: Availability

Parameters

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

  • variant_idquerystring

    pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

  • idpathstringrequired

    pattern ^pj_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • product_idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • datesarray of objectrequired

    • dateobjectrequired

      • datestringrequired

        format date

      • tithistring or nullrequired

    • availablebooleanrequired

    • on_requestbooleanrequired

    • windowsarray of objectrequired

      • windowstringrequired

        one of morning, midday, evening

      • labelstringrequired

      • availablebooleanrequired

      • on_requestbooleanrequired

  • date_being_confirmedbooleanrequired

Its own error codes

  • not_found404

GET /v2/samuhik-pujas/{id}/sessions

A samuhik puja's sessions that can be booked.

  • Scopeavailability:read
  • Rate-limit group: Availability

Parameters

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

  • variant_idquerystring

    pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

  • idpathstringrequired

    pattern ^sp_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • product_idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • sessionsarray of objectrequired

    • idstringrequired

      pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

    • dateobjectrequired

      • datestringrequired

        format date

      • tithistring or nullrequired

    • starts_atstringrequired

      format date-time

    • sankalp_closes_atstringrequired

      format date-time

    • availablebooleanrequired

    • on_requestbooleanrequired

  • date_being_confirmedbooleanrequired

Its own error codes

  • not_found404

GET /v2/packages/{id}/departures

A package's departures and start dates that can be booked.

  • Scopeavailability:read
  • Rate-limit group: Availability

Parameters

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

  • variant_idquerystring

    pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

  • idpathstringrequired

    pattern ^pkg_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • product_idstringrequired

    pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

  • departuresarray of objectrequired

    • departure_idstring or nullrequired

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • startobjectrequired

      • datestringrequired

        format date

      • tithistring or nullrequired

    • endobjectrequired

      • datestringrequired

        format date

      • tithistring or nullrequired

    • availablebooleanrequired

    • on_requestbooleanrequired

Its own error codes

  • not_found404

GET /v2/availability

Dates for up to 20 products at once, over at most 31 days.

  • Scopeavailability:read
  • Rate-limit group: Availability

Parameters

  • idsquerystringrequired

    pattern ^(?:pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}(?:,(?:pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}){0,19}$

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

Responses

200 OK

object

  • productsarray of objectrequired

    • product_idstringrequired

      pattern ^(pj|sp|pkg)_[0-9A-HJKMNP-TV-Z]{26}$

    • kindstringrequired

      one of puja, samuhik_puja, package

    • datesarray of objectrequired

      • dateobjectrequired

        • datestringrequired

          format date

        • tithistring or nullrequired

      • option_idstring or nullrequired

      • availablebooleanrequired

      • on_requestbooleanrequired

    • date_being_confirmedbooleanrequired

GET /v2/availability/changes

Changes to products and their dates, oldest first, from a cursor.

  • Scopeavailability:read
  • Rate-limit group: Availability

Parameters

  • cursorquerystring

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 200 · default 100

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

    • typestringrequired

      one of product.updated, product.withdrawn, availability.changed

    • product_idstringrequired

    • option_idstring or nullrequired

    • occurred_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

  • has_morebooleanrequired

Calendar

3 operations

GET /v2/calendar/cities

The calendar's cities, whose IDs the other calendar routes take.

  • Scopecontent:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Responses

200 OK

object

  • citiesarray of objectrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • defaultsobjectrequired

    • panchangstring or nullrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • festivalsstring or nullrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

GET /v2/calendar/tithis

Each date's tithi at sunrise in a city, over at most 60 days.

  • Scopecontent:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • cityquerystringrequired

    pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

Responses

200 OK

object

  • citystringrequired

    pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

  • itemsarray of objectrequired

    • datestringrequired

      format date

    • weekdaystringrequired

    • labelstringrequired

    • tithistring or nullrequired

GET /v2/calendar/festivals

Festivals in a city, over at most 92 days.

  • Scopecontent:read
  • Publishable key too
  • Rate-limit group: Catalogue and content

Parameters

  • cityquerystring

    pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

  • fromquerystringrequired

    format date

  • toquerystringrequired

    format date

Responses

200 OK

object

  • cityobjectrequired

    • idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

  • itemsarray of objectrequired

    • observance_idstringrequired

      pattern ^(tmp|dst|sth|dei|snt|ash|sty|rte|cir|evt|yat|fes)-[A-Za-z0-9-]+$

    • namestringrequired

    • datestringrequired

      format date

    • labelstringrequired

    • tithistring or nullrequired

    • second_dayobject or nullrequired

      • datestringrequired

        format date

      • labelstringrequired

    • statusstringrequired

      one of calculated, signed_off, under_review, overridden

Quotes

1 operation

POST /v2/quotes

Price a selection at the Agent net, locked 30 minutes, with seats held on request.

  • Scopequotes:write
  • Idempotency-Key optional
  • Rate-limit group: Quotes
Request body

object

  • variant_idstringrequired

    pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

  • service_datestringrequired

    format date

  • departure_idstring

    pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

  • puja_event_idstring

    pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

  • slot_idstring

    pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

  • travellersobjectrequired

    • adultsinteger

      at least 0 · at most 500 · default 0

    • child_with_bedinteger

      at least 0 · at most 500 · default 0

    • child_without_bedinteger

      at least 0 · at most 500 · default 0

    • infantinteger

      at least 0 · at most 500 · default 0

    • peopleinteger

      at least 0 · at most 500 · default 0

  • quantityinteger

    at least 1 · at most 50

  • add_onsarray of object

    up to 30 items · default []

    • add_on_idstringrequired

      pattern ^ad_[0-9A-HJKMNP-TV-Z]{26}$

    • quantityinteger

      at least 1 · at most 500

  • hold_seatsboolean

    default false

Responses

201 Created

object

  • quote_idstringrequired

    pattern ^qt_[0-9A-HJKMNP-TV-Z]{26}$

  • confirmationstringrequired

    one of instant, on_request

  • linesarray of objectrequired

    • product_idstringrequired

    • product_kindstringrequired

      one of puja, samuhik_puja, package, seva, experience, add_on, parivar_plan

    • titlestringrequired

    • variant_idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • variant_namestringrequired

    • service_datestringrequired

      format date

    • service_tostringrequired

      format date

    • departure_idstring or nullrequired

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • puja_event_idstring or nullrequired

      pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring or nullrequired

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

    • travellersobjectrequired

      • adultsintegerrequired

        at least 0 · at most 500 · default 0

      • child_with_bedintegerrequired

        at least 0 · at most 500 · default 0

      • child_without_bedintegerrequired

        at least 0 · at most 500 · default 0

      • infantintegerrequired

        at least 0 · at most 500 · default 0

      • peopleintegerrequired

        at least 0 · at most 500 · default 0

    • net_totalintegerrequired

    • net_amountintegerrequired

    • tirth_gstintegerrequired

    • reference_retail_priceintegerrequired

  • net_totalintegerrequired

  • net_amountintegerrequired

  • tirth_gstintegerrequired

  • reference_retail_priceintegerrequired

  • price_locked_untilstringrequired

    format date-time

  • price_locked_until_textstringrequired

  • holdobject or nullrequired

    • seatsintegerrequired

      more than 0

    • held_untilstringrequired

      format date-time

    • held_until_textstringrequired

  • decision_within_hoursinteger or nullrequired

Its own error codes

  • not_found404
  • not_bookable409
  • hold_refused409
  • holds_disabled409
  • quotes_blocked429
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

Bookings and proof

5 operations

GET /v2/bookings

Find a booking by partner_reference, or list bookings whose status changed.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • partner_referencequerystring

    1 characters or more · up to 64 characters

  • statusquerystring

    one of requested, booked, declined, assigned, scheduled, performed, proof_shared, closed, cancelled

  • updated_sincequerystring

    format date-time

  • cursorquerystring

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 100 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

    • partner_referencestring or nullrequired

    • statusstring or nullrequired

      one of requested, booked, declined, assigned, scheduled, performed, proof_shared, closed, cancelled

    • versionintegerrequired

      at least 0

    • net_totalintegerrequired

    • service_fromstring or nullrequired

      format date

    • updated_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

POST /v2/bookings

Book a quote with your partner_reference, paid from your credit.

  • Scopebookings:write
  • Idempotency-Key required
  • Rate-limit group: Booking writes
Request body

object

  • quote_idstringrequired

    pattern ^qt_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestringrequired

    pattern ^[A-Za-z0-9_-]+$ · 1 characters or more · up to 64 characters

  • sankalpobject

    • namesarray of objectrequired

      1 items or more · up to 20 items

      • namestringrequired

        1 characters or more · up to 120 characters

      • gotrastring or nullrequired

        up to 80 characters

    • join_asstring

      one of attend, watch_live, recorded_video · default recorded_video

  • travellersarray of object

    up to 50 items · default []

    • namestringrequired

      1 characters or more · up to 120 characters

    • age_bandstringrequired

      one of child, adult, senior

    • is_leadboolean

      default false

    • phone_e164string

      pattern ^\+[1-9]\d{7,14}$

    • special_needsarray of string

      up to 10 items · default []

Responses

201 Created

object

  • idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring or nullrequired

  • statusstring or nullrequired

    one of requested, booked, declined, assigned, scheduled, performed, proof_shared, closed, cancelled

  • versionintegerrequired

    at least 0

  • confirmationstringrequired

    one of instant, on_request

  • decide_bystring or nullrequired

    format date-time

  • decide_by_textstring or nullrequired

  • net_totalintegerrequired

  • net_amountintegerrequired

  • tirth_gstintegerrequired

  • linesarray of objectrequired

    • booking_idstringrequired

      pattern ^bk_[0-9A-HJKMNP-TV-Z]{26}$

    • product_idstringrequired

    • product_kindstringrequired

      one of puja, samuhik_puja, package, seva, experience, add_on, parivar_plan

    • titlestringrequired

    • variant_namestringrequired

    • service_fromobjectrequired

      • datestringrequired

        format date

      • labelstringrequired

      • tithistring or nullrequired

      • notestring or nullrequired

    • service_tostringrequired

      format date

    • core_statusstringrequired

    • seatsintegerrequired

    • net_totalintegerrequired

    • net_amountintegerrequired

    • tirth_gstintegerrequired

    • cancellation_policyobjectrequired

      • namestringrequired

      • tiersarray of objectrequired

        • min_hours_beforeintegerrequired

          at least 0 · at most 8760

        • charge_bpintegerrequired

          at least 0 · at most 10000

      • linesarray of stringrequired

    • sankalp_namesarray of objectrequired

      • namestringrequired

      • gotrastring or nullrequired

    • travellersarray of objectrequired

      • namestringrequired

      • age_bandstring or nullrequired

      • is_leadbooleanrequired

    • cancellationobject or nullrequired

      • refund_paiseintegerrequired

      • requested_atstringrequired

        format date-time

      • statusstringrequired

  • amendmentsarray of objectrequired

    • idstringrequired

      pattern ^am_[0-9A-HJKMNP-TV-Z]{26}$

    • statusstringrequired

      one of proposed, accepted, rejected, applied

    • kindstringrequired

      one of date_change, headcount, swap, partner_replacement

    • difference_paiseintegerrequired

    • requested_atstringrequired

      format date-time

  • cancellation_in_reviewobject or nullrequired

    • requested_atstringrequired

      format date-time

  • created_atstringrequired

    format date-time

Its own error codes

  • not_found404
  • quote_used409
  • quote_expired410
  • credit_insufficient402
  • partner_reference_taken409
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

GET /v2/bookings/{id}

Read one booking: status, version, lines, money and policy.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring or nullrequired

  • statusstring or nullrequired

    one of requested, booked, declined, assigned, scheduled, performed, proof_shared, closed, cancelled

  • versionintegerrequired

    at least 0

  • confirmationstringrequired

    one of instant, on_request

  • decide_bystring or nullrequired

    format date-time

  • decide_by_textstring or nullrequired

  • net_totalintegerrequired

  • net_amountintegerrequired

  • tirth_gstintegerrequired

  • linesarray of objectrequired

    • booking_idstringrequired

      pattern ^bk_[0-9A-HJKMNP-TV-Z]{26}$

    • product_idstringrequired

    • product_kindstringrequired

      one of puja, samuhik_puja, package, seva, experience, add_on, parivar_plan

    • titlestringrequired

    • variant_namestringrequired

    • service_fromobjectrequired

      • datestringrequired

        format date

      • labelstringrequired

      • tithistring or nullrequired

      • notestring or nullrequired

    • service_tostringrequired

      format date

    • core_statusstringrequired

    • seatsintegerrequired

    • net_totalintegerrequired

    • net_amountintegerrequired

    • tirth_gstintegerrequired

    • cancellation_policyobjectrequired

      • namestringrequired

      • tiersarray of objectrequired

        • min_hours_beforeintegerrequired

          at least 0 · at most 8760

        • charge_bpintegerrequired

          at least 0 · at most 10000

      • linesarray of stringrequired

    • sankalp_namesarray of objectrequired

      • namestringrequired

      • gotrastring or nullrequired

    • travellersarray of objectrequired

      • namestringrequired

      • age_bandstring or nullrequired

      • is_leadbooleanrequired

    • cancellationobject or nullrequired

      • refund_paiseintegerrequired

      • requested_atstringrequired

        format date-time

      • statusstringrequired

  • amendmentsarray of objectrequired

    • idstringrequired

      pattern ^am_[0-9A-HJKMNP-TV-Z]{26}$

    • statusstringrequired

      one of proposed, accepted, rejected, applied

    • kindstringrequired

      one of date_change, headcount, swap, partner_replacement

    • difference_paiseintegerrequired

    • requested_atstringrequired

      format date-time

  • cancellation_in_reviewobject or nullrequired

    • requested_atstringrequired

      format date-time

  • created_atstringrequired

    format date-time

Its own error codes

  • not_found404

GET /v2/bookings/{id}/proof

A booking's proof as signed links valid 24 hours.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • itemsarray of objectrequired

    • kindstringrequired

      one of video, photo, courier_tracking

    • urlstring or nullrequired

      format uri

    • tracking_refstring or nullrequired

    • names_read_at_secondsinteger or nullrequired

      at least 0

    • shared_atstringrequired

      format date-time

  • links_valid_untilstringrequired

    format date-time

  • links_valid_until_textstringrequired

Its own error codes

  • not_found404

GET /v2/bookings/{id}/proof/{index}

Open one piece of proof through its signed link.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • expiresqueryintegerrequired

    more than 0

  • signaturequerystringrequired

    pattern ^[0-9a-f]{64}$

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • indexpathintegerrequired

    at least 0 · at most 99

Responses

200 OK

No body.

Its own error codes

  • not_found404
  • gone410

Change feed

2 operations

GET /v2/booking-changes

Status changes after the last one you acknowledged, oldest first.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • afterquerystring

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 200 · default 100

Responses

200 OK

object

  • itemsarray of objectrequired

    • event_idstringrequired

      pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

    • booking_idstringrequired

      pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

    • partner_referencestring or nullrequired

    • statusstringrequired

      one of requested, booked, declined, assigned, scheduled, performed, proof_shared, closed, cancelled

    • versionintegerrequired

      at least 1

    • occurred_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

  • last_acked_event_idstring or nullrequired

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

POST /v2/booking-changes/ack

Acknowledge the change feed up to an event.

  • Scopebookings:read
  • Rate-limit group: Booking reads
Request body

object

  • event_idstringrequired

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • last_acked_event_idstringrequired

    pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

Its own error codes

  • not_found404

Amendments

2 operations

POST /v2/bookings/{id}/amendment-quotes

What a change to a booking would cost now. Nothing is written.

  • Scopebookings:write
  • Idempotency-Key optional
  • Rate-limit group: Booking writes

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Request body

object

  • changeone of: object, object, objectrequired

    Option 1

    • kindstringrequired

      one of date_change

    • new_datestringrequired

      format date

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • puja_event_idstring

      pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

    Option 2

    • kindstringrequired

      one of headcount

    • travellersobjectrequired

      • adultsinteger

        at least 0 · at most 500 · default 0

      • child_with_bedinteger

        at least 0 · at most 500 · default 0

      • child_without_bedinteger

        at least 0 · at most 500 · default 0

      • infantinteger

        at least 0 · at most 500 · default 0

      • peopleinteger

        at least 0 · at most 500 · default 0

    • quantityinteger

      at least 1 · at most 50

    Option 3

    • kindstringrequired

      one of swap

    • new_variant_idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • changeone of: object, object, objectrequired

    Option 1

    • kindstringrequired

      one of date_change

    • new_datestringrequired

      format date

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • puja_event_idstring

      pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

    Option 2

    • kindstringrequired

      one of headcount

    • travellersobjectrequired

      • adultsintegerrequired

        at least 0 · at most 500 · default 0

      • child_with_bedintegerrequired

        at least 0 · at most 500 · default 0

      • child_without_bedintegerrequired

        at least 0 · at most 500 · default 0

      • infantintegerrequired

        at least 0 · at most 500 · default 0

      • peopleintegerrequired

        at least 0 · at most 500 · default 0

    • quantityinteger

      at least 1 · at most 50

    Option 3

    • kindstringrequired

      one of swap

    • new_variant_idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

  • current_total_paiseintegerrequired

  • new_total_paiseintegerrequired

  • difference_paiseintegerrequired

  • price_locked_untilstringrequired

    format date-time

  • price_locked_until_textstringrequired

Its own error codes

  • not_found404
  • not_amendable409
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

POST /v2/bookings/{id}/amendments

Ask for a change to a booking. Tirth's team makes it.

  • Scopebookings:write
  • Idempotency-Key required
  • Rate-limit group: Booking writes

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Request body

object

  • changeone of: object, object, objectrequired

    Option 1

    • kindstringrequired

      one of date_change

    • new_datestringrequired

      format date

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • puja_event_idstring

      pattern ^ss_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

    Option 2

    • kindstringrequired

      one of headcount

    • travellersobjectrequired

      • adultsinteger

        at least 0 · at most 500 · default 0

      • child_with_bedinteger

        at least 0 · at most 500 · default 0

      • child_without_bedinteger

        at least 0 · at most 500 · default 0

      • infantinteger

        at least 0 · at most 500 · default 0

      • peopleinteger

        at least 0 · at most 500 · default 0

    • quantityinteger

      at least 1 · at most 50

    Option 3

    • kindstringrequired

      one of swap

    • new_variant_idstringrequired

      pattern ^var_[0-9A-HJKMNP-TV-Z]{26}$

    • departure_idstring

      pattern ^dep_[0-9A-HJKMNP-TV-Z]{26}$

    • slot_idstring

      pattern ^slt_[0-9A-HJKMNP-TV-Z]{26}$

  • expected_difference_paiseinteger

Responses

201 Created

object

  • idstringrequired

    pattern ^am_[0-9A-HJKMNP-TV-Z]{26}$

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • statusstringrequired

    one of proposed, accepted, rejected, applied

  • kindstringrequired

    one of date_change, headcount, swap, partner_replacement

  • difference_paiseintegerrequired

  • new_total_paiseinteger or nullrequired

  • requested_atstringrequired

    format date-time

Its own error codes

  • not_found404
  • not_amendable409
  • price_changed412
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

Cancellations and refunds

4 operations

GET /v2/bookings/{id}/cancellation-quote

The refund under the booking's frozen policy, with a signed token.

  • Scopebookings:cancel
  • Rate-limit group: Booking reads

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • paid_paiseintegerrequired

  • charge_bpintegerrequired

  • charge_paiseintegerrequired

  • refund_paiseintegerrequired

  • valid_untilstringrequired

    format date-time

  • valid_until_textstringrequired

  • quote_tokenstringrequired

  • policy_linesarray of stringrequired

Its own error codes

  • not_found404
  • not_cancellable409
  • cancellation_closed409

POST /v2/bookings/{id}/cancellations

Cancel a booking before its start. The refund goes to your credit.

  • Scopebookings:cancel
  • Idempotency-Key required
  • Rate-limit group: Booking writes

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Request body

object

  • quote_tokenstring

    10 characters or more · up to 600 characters

  • refundstring

    one of policy, full · default policy

  • reasonstringrequired

    one of customer_request, duplicate_booking, service_issue, travel_disruption, other

Responses

200 OK

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • statusstringrequired

    one of approved, in_review

  • refund_paiseinteger or nullrequired

  • cancellation_idsarray of stringrequired

202 Accepted

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • statusstringrequired

    one of approved, in_review

  • refund_paiseinteger or nullrequired

  • cancellation_idsarray of stringrequired

Its own error codes

  • not_found404
  • not_cancellable409
  • cancellation_closed409
  • quote_expired410
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

GET /v2/refunds

Refunds to your credit, newest first.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • cursorquerystring

    pattern ^rf_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 100 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^rf_[0-9A-HJKMNP-TV-Z]{26}$

    • booking_idstring or nullrequired

      pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

    • amount_paiseintegerrequired

    • statusstringrequired

    • reasonstringrequired

    • labelstring or nullrequired

    • created_atstringrequired

      format date-time

    • completed_atstring or nullrequired

      format date-time

  • next_cursorstring or nullrequired

    pattern ^rf_[0-9A-HJKMNP-TV-Z]{26}$

GET /v2/refunds/{id}

Read one refund.

  • Scopebookings:read
  • Rate-limit group: Booking reads

Parameters

  • idpathstringrequired

    pattern ^rf_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^rf_[0-9A-HJKMNP-TV-Z]{26}$

  • booking_idstring or nullrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • amount_paiseintegerrequired

  • statusstringrequired

  • reasonstringrequired

  • labelstring or nullrequired

  • created_atstringrequired

    format date-time

  • completed_atstring or nullrequired

    format date-time

Its own error codes

  • not_found404

Credit and invoices

5 operations

GET /v2/credit

Your credit balance, its open lots and transfers waiting to be matched.

  • Scopecredit:read
  • Rate-limit group: Overall only

Responses

200 OK

object

  • balance_paiseintegerrequired

  • low_balance_alert_paiseinteger or nullrequired

  • lowbooleanrequired

  • lotsarray of objectrequired

    • idstringrequired

      pattern ^lot_[0-9A-HJKMNP-TV-Z]{26}$

    • amount_paiseintegerrequired

    • remaining_paiseintegerrequired

    • opened_atstringrequired

      format date-time

    • expires_onstring or nullrequired

      format date

  • waiting_for_verification_paiseintegerrequired

GET /v2/credit/transactions

Every credit movement, newest first.

  • Scopecredit:read
  • Rate-limit group: Overall only

Parameters

  • cursorquerystring

    pattern ^je_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 100 · default 50

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^je_[0-9A-HJKMNP-TV-Z]{26}$

    • typestringrequired

      one of top_up, booking, held_for_request, released, refund, lot_expired, withdrawal, withdrawal_reversed, incentive, adjustment, other

    • labelstringrequired

    • referenceobjectrequired

      • typestringrequired

      • idstringrequired

    • amount_paiseintegerrequired

    • occurred_atstringrequired

      format date-time

    • lot_idsarray of stringrequired

    • lot_expires_onstring or nullrequired

      format date

  • next_cursorstring or nullrequired

    pattern ^je_[0-9A-HJKMNP-TV-Z]{26}$

GET /v2/credit/statements/{month}

The statement of a month that has ended, as CSV.

  • Scopecredit:read
  • Rate-limit group: Overall only

Parameters

  • monthpathstringrequired

    pattern ^\d{4}-(0[1-9]|1[0-2])$

Responses

200 OK

No body.

Its own error codes

  • not_found404

POST /v2/credit/top-ups

Tell Tirth of a bank transfer already sent, with its UTR.

  • Scopecredit:topup
  • Idempotency-Key required
  • Rate-limit group: Overall only
Request body

object

  • amount_paiseintegerrequired

    at least 100 · at most 100000000

  • referencestringrequired

    pattern ^[A-Za-z0-9-]{6,40}$

Responses

201 Created

object

  • idstringrequired

    pattern ^top_[0-9A-HJKMNP-TV-Z]{26}$

  • amount_paiseintegerrequired

  • statusstringrequired

    one of pending, paid, failed

  • referencestring or nullrequired

  • created_atstringrequired

    format date-time

  • paid_atstring or nullrequired

    format date-time

  • instructionsstringrequired

Its own error codes

  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

GET /v2/invoices

The GST documents Tirth issued to your company.

  • Scopeinvoices:read
  • Rate-limit group: Overall only

Parameters

  • cursorquerystring

    1 characters or more · up to 40 characters

  • limitqueryinteger

    at least 1 · at most 100 · default 50

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

    • numberstringrequired

    • typestringrequired

      one of tax_invoice, bill_of_supply, credit_note, invoice, receipt_voucher

    • booking_idstring or nullrequired

    • place_of_supplystringrequired

    • taxable_paiseintegerrequired

    • cgst_paiseintegerrequired

    • sgst_paiseintegerrequired

    • igst_paiseintegerrequired

    • total_paiseintegerrequired

    • issued_atstringrequired

      format date-time

    • original_numberstring or nullrequired

    • pdf_readybooleanrequired

  • next_cursorstring or nullrequired

Webhooks

5 operations

GET /v2/webhook-endpoints

Your webhook endpoints in this environment.

  • Scopewebhooks:manage
  • Rate-limit group: Overall only

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

    • urlstringrequired

    • event_typesarray of stringrequired

    • statusstringrequired

      one of active, disabled

    • disabled_reasonstring or nullrequired

    • failing_sincestring or nullrequired

      format date-time

    • secret_rotated_atstring or nullrequired

      format date-time

    • created_atstringrequired

      format date-time

POST /v2/webhook-endpoints

Add an endpoint. Its signing secret is shown once.

  • Scopewebhooks:manage
  • Idempotency-Key optional
  • Rate-limit group: Overall only
Request body

object

  • urlstringrequired

    format uri · up to 2048 characters

  • event_typesarray of string

    1 items or more · up to 9 items

Responses

201 Created

object

  • idstringrequired

    pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

  • urlstringrequired

  • event_typesarray of stringrequired

  • statusstringrequired

    one of active, disabled

  • disabled_reasonstring or nullrequired

  • failing_sincestring or nullrequired

    format date-time

  • secret_rotated_atstring or nullrequired

    format date-time

  • created_atstringrequired

    format date-time

  • secretstringrequired

Its own error codes

  • endpoint_limit_reached409
  • conflict409
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

DELETE /v2/webhook-endpoints/{id}

Switch an endpoint off. Its waiting deliveries stop.

  • Scopewebhooks:manage
  • Rate-limit group: Overall only

Parameters

  • idpathstringrequired

    pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

No body.

Its own error codes

  • not_found404

POST /v2/webhook-endpoints/{id}/rotate-secret

A new signing secret, with the old one still signing for 24 hours.

  • Scopewebhooks:manage
  • Idempotency-Key optional
  • Rate-limit group: Overall only

Parameters

  • idpathstringrequired

    pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • idstringrequired

    pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

  • urlstringrequired

  • event_typesarray of stringrequired

  • statusstringrequired

    one of active, disabled

  • disabled_reasonstring or nullrequired

  • failing_sincestring or nullrequired

    format date-time

  • secret_rotated_atstring or nullrequired

    format date-time

  • created_atstringrequired

    format date-time

  • secretstringrequired

Its own error codes

  • not_found404
  • conflict409
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

GET /v2/webhook-deliveries

Deliveries from the last 30 days, newest first.

  • Scopewebhooks:manage
  • Rate-limit group: Overall only

Parameters

  • endpoint_idquerystring

    pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

  • cursorquerystring

    pattern ^whd_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 100 · default 50

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^whd_[0-9A-HJKMNP-TV-Z]{26}$

    • endpoint_idstringrequired

      pattern ^whe_[0-9A-HJKMNP-TV-Z]{26}$

    • event_idstringrequired

      pattern ^evt_[0-9A-HJKMNP-TV-Z]{26}$

    • typestring or nullrequired

    • booking_idstring or nullrequired

    • statusstringrequired

      one of pending, delivered, failed, dead

    • attemptsintegerrequired

    • response_codeinteger or nullrequired

    • response_msinteger or nullrequired

    • last_errorstring or nullrequired

    • next_attempt_atstring or nullrequired

      format date-time

    • created_atstringrequired

      format date-time

  • next_cursorstring or nullrequired

    pattern ^whd_[0-9A-HJKMNP-TV-Z]{26}$

Cases

2 operations

GET /v2/cases

Your cases with their messages.

  • Scopecases:write
  • Rate-limit group: Overall only

Parameters

  • statusquerystring

    one of open, waiting, resolved, closed

  • cursorquerystring

    pattern ^case_[0-9A-HJKMNP-TV-Z]{26}$

  • limitqueryinteger

    at least 1 · at most 50 · default 20

Responses

200 OK

object

  • itemsarray of objectrequired

    • idstringrequired

      pattern ^case_[0-9A-HJKMNP-TV-Z]{26}$

    • booking_idstring or nullrequired

      pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

    • partner_referencestring or nullrequired

    • categorystringrequired

    • prioritystringrequired

      one of p1, p2, p3, p4

    • statusstringrequired

      one of open, waiting, resolved, closed

    • first_reply_due_atstring or nullrequired

      format date-time

    • resolution_due_atstring or nullrequired

      format date-time

    • created_atstringrequired

      format date-time

    • messagesarray of objectrequired

      • idstringrequired

        pattern ^cmsg_[0-9A-HJKMNP-TV-Z]{26}$

      • fromstringrequired

        one of you, tirth, system

      • bodystringrequired

      • created_atstringrequired

        format date-time

  • next_cursorstring or nullrequired

    pattern ^case_[0-9A-HJKMNP-TV-Z]{26}$

POST /v2/cases

Ask Tirth support about one of your bookings.

  • Scopecases:write
  • Rate-limit group: Overall only
Request body

object

  • booking_idstring

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring

    pattern ^[A-Za-z0-9_-]{1,64}$

  • categorystringrequired

    one of change, cancel, refund, on_trip, proof, payment, other

  • messagestringrequired

    5 characters or more · up to 2000 characters

Responses

201 Created

object

  • idstringrequired

    pattern ^case_[0-9A-HJKMNP-TV-Z]{26}$

  • booking_idstring or nullrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring or nullrequired

  • categorystringrequired

  • prioritystringrequired

    one of p1, p2, p3, p4

  • statusstringrequired

    one of open, waiting, resolved, closed

  • first_reply_due_atstring or nullrequired

    format date-time

  • resolution_due_atstring or nullrequired

    format date-time

  • created_atstringrequired

    format date-time

  • messagesarray of objectrequired

    • idstringrequired

      pattern ^cmsg_[0-9A-HJKMNP-TV-Z]{26}$

    • fromstringrequired

      one of you, tirth, system

    • bodystringrequired

    • created_atstringrequired

      format date-time

Its own error codes

  • not_found404

Privacy requests

1 operation

POST /v2/privacy-requests

File a pilgrim's request for a copy of their data, or to delete it.

  • Scopeprivacy:write
  • Idempotency-Key required
  • Rate-limit group: Overall only
Request body

object

  • booking_idstring

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring

    pattern ^[A-Za-z0-9_-]{1,64}$

  • kindstringrequired

    one of access, erasure

  • traveller_idsarray of string

    up to 20 items

Responses

201 Created

object

  • idstringrequired

    pattern ^dsr_[0-9A-HJKMNP-TV-Z]{26}$

  • kindstringrequired

    one of access, erasure

  • statusstringrequired

    one of received, in_progress, completed, rejected, cancelled

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • partner_referencestring or nullrequired

  • traveller_idsarray of stringrequired

  • due_atstringrequired

    format date-time

  • requested_atstringrequired

    format date-time

Its own error codes

  • not_found404
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409

Sandbox

1 operation

POST /v2/sandbox/bookings/{id}/advance

Move a sandbox booking one stage on, and send that stage's webhook.

  • Scopebookings:write
  • Idempotency-Key optional
  • Sandbox only
  • Rate-limit group: Booking writes

Parameters

  • idpathstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

Responses

200 OK

object

  • booking_idstringrequired

    pattern ^ord_[0-9A-HJKMNP-TV-Z]{26}$

  • previous_statusstringrequired

  • statusstringrequired

    one of assigned, scheduled, performed, proof_shared

  • versionintegerrequired

    at least 1

Its own error codes

  • sandbox_only404
  • not_found404
  • not_advanceable409
  • idempotency_key_required400
  • idempotency_key_reused409
  • idempotency_in_progress409