v1

Create Copay Request

Generate a Copay Request to retrieve copay information on a patient's prescription(s). We can support multiple insurances on a copay request

post/v1/copay_request

Request

Request body

prescriptionsstring[]

Patient's prescriptions.

insurance_tokenstring[]
metadatastring

Customer-side identifier to reference the Copay Request in Customer system

patient_tokenstring required

Patient token

notesstring

Additional information customer wishes to convey relating to this Copay Request

ship_to_statestring

State prescription is being shipped to as 2 letter abbreviation

patient_payment_type'cash' | 'insurance'

Whether to run with insurance (must be provided) or as cash

Example request

{
  "prescriptions": [
    {
      "prescription_token": "z3q2jr",
      "quantity": 8.7,
      "days_supply": 30,
      "patient_consent": {
        "consent_statement": "Patient Bruce Banner consented that Truepill pharmacy will bill their insurance in order to provide a fill of Medication Sildenafil 10mg for a quantity of 10.",
        "patient_name": "Bruce Banner",
        "consent_provided_by": "Hulk",
        "item": "sildenafil 10mg",
        "consent_method": "VERBAL",
        "consent_date": " 2021-01-25 15:17:51.000Z",
        "consent_type": "INSURANCE"
      },
      "claim_overrides": [
        {
          "insurance_token": "adcbc795028c009d",
          "prior_authorization_number": "ABC123",
          "submission_clarification_code": "4"
        },
        {
          "insurance_token": "75539ed9ffb86f38",
          "other_coverage_code": "8"
        }
      ]
    },
    "b5q3t2",
    "h3r55c"
  ],
  "insurance_token": [
    "skhsyq83rkd3uht9",
    "ubqfc1a0a17hjb1c",
    "oi4aafwcsv5zzvvj"
  ],
  "metadata": "cfe146",
  "patient_token": "4526d90a",
  "notes": "This is a note",
  "ship_to_state": "CA"
}

Response

Accepted

request_idstring
timestampinteger
statusstring

Example response

{
  "request_id": "40277544de5c6ba685dc4161e189d3e2",
  "status": "success",
  "details": {
    "copay_request_token": "a2fcd842de60b010",
    "copay_request_prescriptions_tokens": [
      {
        "prescription_token": "9df7a51822e2",
        "copay_request_prescription_token": "e13eab97b91c6b27",
        "status": "pending"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.