{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/elysiolab/2gotrips-integration/1.0.0"},{"description":"Endpoint for Nola(New Orleans) Instance","url":"https://dashnola.2gotrips.com"}],"info":{"version":"1.0.0","title":"2gotrips - Integration","description":"This is the integration documentation for payments partners do the integration with drivers and also access triplog data to process transactions on drivers bank accounts."},"security":[{"bearerAuth":[]}],"paths":{"/integration/data/driver":{"post":{"summary":"Create Driver","description":"This endpoints creates a Driver on 2gotrips instance. By now the fields markets_id and operators_id will have a fixed value.","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DriverPayload"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriverCreatedSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriverErrorResponse"}}}}}},"patch":{"summary":"Patch Existing Driver","description":"This endpoints patches a Driver on 2gotrips instance. You can send only the fields that you wanna to patch and driver email is always required.","security":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/DriverPayload"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriverPatchedSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DriverErrorResponse"}}}}}}},"/integration/data/triplog":{"post":{"summary":"Get Triplog Data","description":"Get paginated data from triplog","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/TriplogPayload"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriplogSuccessResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriplogErrorResponse"}}}}}}}},"components":{"schemas":{"DriverPayload":{"type":"object","properties":{"name":{"description":"Driver Name (required|max:50)","type":"string"},"email":{"description":"Driver Email (email|required|max:100)","type":"string"},"home_phone":{"description":"Driver Home Phone (required|max:15)","type":"string"},"mobile_phone":{"description":"Driver Email (required|max:15)","type":"string"},"hacklicense_number":{"description":"Driver Hack License Number (required|max:10)","type":"string"},"hacklicense_image":{"description":"Driver Hack License Image (nullable|max:150) We can store the base64 here too...","type":"string"},"hacklicense_expiration":{"description":"Driver Hack License Expiration Date (required|date_format:m-d-Y)","type":"string"},"driverlicense_number":{"description":"Driver License Number (required|max:15)","type":"string"},"driverlicense_image":{"description":"Driver License Image (nullable|max:150) We can store the base64 here too...","type":"string"},"driverlicense_expiration":{"description":"Driver License Expiration Date (required|date_format:m-d-Y)","type":"string"},"st_insurable":{"description":"Driver Email (nullable|boolean)","type":"boolean"},"birthday":{"description":"Driver Birthday Date (required|date_format:m-d-Y)","type":"string"},"password":{"description":"Driver Access Password (nullable|min:6)","type":"string"},"ssn":{"description":"Social Security Number (required|max:15)","type":"string"},"address_field1":{"description":"Driver Address Field 1 (nullable|max:150)","type":"string"},"address_field2":{"description":"Driver Address Field 2 (nullable|max:150)","type":"string"},"address_zip":{"description":"Driver Address ZipCode (required|max:10)","type":"string"},"address_region":{"description":"Driver Address Region (required|max:30)","type":"string"},"address_city":{"description":"Driver Address City (required|max:30)","type":"string"},"bank_name":{"description":"Driver Bank Name (nullable|max:30)","type":"string"},"bank_accountnumber":{"description":"Driver Bank Account Number (nullable|max:30)","type":"string"},"bank_routingnumber":{"description":"Driver Bank Routing Number (nullable|max:30)","type":"string"},"driver_rating":{"description":"Driver Email (nullable|max:1)","type":"string"},"markets_id":{"description":"Driver Email (required)","type":"string"},"operators_id":{"description":"Driver Email (required)","type":"string"},"is_active":{"description":"Driver Active Status (boolean)","type":"string"}}},"DriverCreatedSuccessResponse":{"type":"object","properties":{"message":{"description":"Operation Message","type":"string","example":"The driver was successfully created"},"2goDriverId":{"description":"return params","type":"array","items":{"type":"object","properties":{"driver":{"description":"Driver ID","type":"number","example":15}}}}}},"DriverPatchedSuccessResponse":{"type":"object","properties":{"message":{"description":"Operation Message","type":"string","example":"The driver was successfully patched"},"2goDriverId":{"description":"return params","type":"array","items":{"type":"object","properties":{"driver":{"description":"Driver ID","type":"number","example":15}}}}}},"DriverErrorResponse":{"type":"object","properties":{"success":{"description":"Transaction Success?","type":"boolean","example":false},"message":{"description":"Error Message","type":"string","example":"The given data was invalid."},"returnData":{"description":"return params","type":"object","properties":{"errors":{"description":"error bag","type":"object","properties":{"operator_id":{"description":"name of the attribute","type":"array","items":{"type":"string","example":"The selected operators id is invalid."}}}}}}}},"TriplogPayload":{"type":"object","properties":{"drivers_id":{"description":"Driver Id (required|number)","type":"number","example":1},"page":{"description":"Page number (required|number)","type":"number","example":1},"per_page":{"description":"Number of records per page (required|number)","type":"number","example":15}}},"TriplogSuccessResponse":{"type":"object","properties":{"success":{"description":"Operation Success","type":"boolean","example":true},"triplogs":{"type":"object","properties":{"current_page":{"type":"number","example":1},"data":{"type":"array","items":{"properties":{"id":{"type":"number","description":"Triplog ID","example":4},"vehicles_id":{"type":"number","description":"Vehicle ID","example":4},"date_pickup":{"type":"string","description":"Pickup Date","example":"2021-12-30 13:03:04"},"date_dropoff":{"type":"string","description":"Dropoff Date","example":"2021-12-30 13:03:04"},"time_pickup":{"type":"string","example":"00:00:00"},"time_dropoff":{"type":"string","example":"00:00:00"},"pickup_desc":{"type":"string","example":"1 Terminal Dr, Kenner, LA 70062, USA"},"pickup_lat":{"type":"string","example":"29.991090500"},"pickup_long":{"type":"string","example":"-90.259229900"},"dropoff_desc":{"type":"string","example":"Convention Center Blvd, New Orleans, LA 70130, USA"},"dropoff_lat":{"type":"string","example":"29.942692700"},"dropoff_long":{"type":"string","example":"-90.064477500"},"drivers_id":{"type":"number","example":1},"operators_id":{"type":"number","example":1},"markets_id":{"type":"number","example":1},"dims_id":{"type":"number","example":1},"pims_id":{"type":"number","example":1},"rate_type":{"type":"string","example":"meter"},"price_total":{"type":"string","example":69.5},"price_trip":{"type":"string","example":65.5},"price_extra":{"type":"string","example":1.0},"price_surcharge":{"type":"number","example":1.0},"price_tip":{"type":"number","example":1.0},"price_service_fee":{"type":"number","example":1.0},"ehail_type":{"type":"number","example":"2GOTRIPS"},"ehail_number":{"type":"string","example":1},"paymentmethods_id":{"type":"number","example":1},"ccard_number":{"type":"string","example":null},"ccard_approval_code":{"type":"string","example":null},"ccard_preauth_amount":{"type":"string","example":null},"payment_details":{"type":"string","example":null},"triplogstatuses_id":{"type":"number","example":2},"system_fee":{"type":"string","example":null},"ccard_residual":{"type":"number","example":1},"per_day_fee":{"type":"number","example":1},"per_week_fee":{"type":"number","example":1},"per_month_fee":{"type":"number","example":1},"st_billed":{"type":"boolean","example":1},"st_fee_driver":{"type":"boolean","example":1},"st_fee_operator":{"type":"boolean","example":1},"st_fee_market":{"type":"boolean","example":1},"promo_code":{"type":"string","example":null},"charged_amt":{"type":"string","example":null},"acquirer":{"type":"string","example":null},"payment_log":{"type":"string","example":null},"created_at":{"type":"string","example":"2022-02-22 15:09:40"},"updated_at":{"type":"string","example":"2022-02-22 15:22:24"},"deleted_at":{"type":"string","example":"2022-02-22 19:22:24"},"vehicle":{"$ref":"#/components/schemas/VehicleResponse"}}}}}}}},"VehicleResponse":{"type":"object","properties":{"id":{"type":"number","example":2},"identification":{"type":"string","example":"VIN111222333444"},"make":{"type":"string","example":"Toyota"},"model":{"type":"string","example":"Siena"},"year":{"type":"number","example":2017},"vehicletypes_id":{"type":"number","example":1},"operators_id":{"type":"number","example":4},"medallionlicense_number":{"type":"number","example":null},"leases_id":{"type":"number","example":null},"insurancetypes_id":{"type":"number","example":1},"insurance_company":{"type":"string","example":null},"insurance_agency":{"type":"string","example":null},"insurance_expiration":{"type":"string","example":null},"tag_expiration":{"type":"string","example":null},"vehicle_owner":{"type":"string","example":"White Fleet"},"tag":{"type":"string","example":"NOLA-001"},"color":{"type":"string","example":"White"},"created_at":{"type":"string","example":"2021-11-01 15:34:57"},"updated_at":{"type":"string","example":"2021-11-01 15:34:57"},"deleted_at":{"type":"string","example":"2021-11-01 18:34:57"}}},"DriverResponse":{"type":"object","properties":{"id":{"type":"string","example":3},"uuid":{"type":"string","example":"e3929e9c-3de6-40aa-8d37-83b7ed2e48e8"},"email":{"type":"string","example":"2gomariodriver@gmail.com"},"operators_id":{"type":"string","example":4},"markets_id":{"type":"string","example":1},"name":{"type":"string","example":"MarioDriver"},"mobile_phone":{"type":"string","example":3059420689},"home_phone":{"type":"string","example":"954-9999999"},"hacklicense_number":{"type":"string","example":9292},"hacklicense_expiration":{"type":"string","example":"2021-09-17 10:07:03"},"hacklicense_image":{"type":"string","example":null},"driverlicense_number":{"type":"string","example":123456789},"driverlicense_expiration":{"type":"string","example":"2021-12-17 10:07:03"},"driverlicense_image":{"type":"string","example":null},"st_insurable":{"type":"string","example":false},"ssn":{"type":"string","example":123456789},"address_field1":{"type":"string","example":"199 nw 79 st"},"address_field2":{"type":"string","example":null},"address_zip":{"type":"string","example":33150},"address_city":{"type":"string","example":"Miami"},"address_region":{"type":"string","example":"FL"},"bank_name":{"type":"string","example":null},"bank_accountnumber":{"type":"string","example":null},"bank_routingnumber":{"type":"string","example":null},"driver_rating":{"type":"string","example":null},"created_at":{"type":"string","example":"2021-06-03 10:07:03"},"updated_at":{"type":"string","example":"2021-06-03 10:07:03"},"deleted_at":{"type":"string","example":null}}},"TriplogErrorResponse":{"type":"object","properties":{"success":{"description":"Transaction Success?","type":"boolean","example":false},"message":{"description":"Error Message","type":"string","example":"The given data was invalid."},"returnData":{"description":"return params","type":"object","properties":{"errors":{"description":"error bag","type":"object","properties":{"operator_id":{"description":"name of the attribute","type":"array","items":{"type":"string","example":"The selected operators id is invalid."}}}}}}}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}