v1

Get a Transfer by token

Once a transfer has been created in the Truepill ecosystem, you can access the transfer information at any time using the transfer_token that was provided on the Create Transfer response.<br/><br/>If the transfer_token does not map to a transfer record, a 404 Not Found will be returned.<br/><br/>Querying for transfer information that does not belong to you will return an error response.

get/v1/transfer_request/{token}

Request

Path parameters

tokenstring required

Transfer token

Response

OK

created_atstring
url_tokenstring
statusstring
cancel_reasonstring
cancel_reason_otherstring
pharmacy_namestring
pharmacy_phonestring
prescriber_namestring
prescriber_phonestring
notesstring
metadatastring
reject_reasonstring
reject_reason_otherstring

Example response

[
  {
    "created_at": "2021-02-28T22:34:50.000Z",
    "url_token": "e4bce6d1e2",
    "status": "completed",
    "pharmacy_name": "Test",
    "pharmacy_phone": "+1 (111) 222-3333",
    "notes": "A note",
    "metadata": "m3t4",
    "transfer_medications": [
      {
        "url_token": "e6014ac9da658c1c",
        "medication_name": "duloxetine 30mg capsule",
        "prescription": {
          "url_token": "0a5211b5f1db",
          "prescribed_written_name": "Lisinopril 5 mg Oral Tablet",
          "prescribed_generic_name": "Generic 10mg tablet",
          "last_filled_date": "2021-02-28T22:34:50.000Z",
          "prescribed_quantity": 60,
          "prescriber": "Dr. Nick Rivera",
          "medication_name": "Generic 10mg tablet",
          "days_supply": "30",
          "num_refills_filled": "0"
        }
      }
    ]
  }
]

Changes

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