List Reconciliation Transactions

import requests
url = "https://dev-api.truemed.com/api/v1/reconciliation/transactions"
querystring = {"start_date":"start_date","end_date":"end_date"}
payload = {}
headers = {
    "x-truemed-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers, params=querystring)
print(response.json())

{
  "transactions": [
    {
      "charge_date": "2023-01-15",
      "fee": 2.75,
      "order_id": "ord_987654321",
      "order_items": "Vitamin C Supplement, Omega 3 Fish Oil",
      "order_total": 59.99,
      "payment_id": "pay_123456789",
      "payout_date": "2023-01-20",
      "payout_id": "po_20230120_001",
      "type": "Charge",
      "customer_id": "d4f1e7a2-9c3b-4f6a-8e2d-1a2b3c4d5e6f",
      "email": "jane.doe@example.com",
      "metadata": "promo_code=NEWYEAR2023",
      "name": "Jane Doe",
      "refund_needs_invoicing": null
    }
  ],
  "pagination": {
    "count": 1,
    "current_page": 1,
    "last_page": 1,
    "page_size": 1
  }
}

Returns a paginated list of transaction reconciliation data for the authenticated merchant within the specified date range.

Authentication

x-truemed-api-keystring

Sales channel API key for merchant server-to-server authentication

Query parameters

pageintegerOptional

Optional field indicating which page to access. Defaults to 1.

page_sizeintegerOptional

Optional field indicating the number of records per page. Defaults to 30.

start_datedateRequired

Start of the date range, inclusive (YYYY-MM-DD).

end_datedateRequired

End of the date range, inclusive (YYYY-MM-DD).

payout_idslist of stringsOptional

Comma-separated payout IDs to filter by, e.g. po_1,po_2.

include_pending_payoutsbooleanOptional

When true (default), include transactions not yet associated with a payout. When false, return only rows with an associated payout.

Response

Successful response

transactionslist of objects

Paginated list of transaction data.

paginationobject or null

A pagination object with information about the current page, page size, total count, and last page.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

501

Not Implemented Error