List Reconciliation Payouts

import requests
url = "https://dev-api.truemed.com/api/v1/reconciliation/payouts"
querystring = {"start_date":"2024-05-01","end_date":"2024-05-31","page":"1","page_size":"30"}
payload = {}
headers = {
    "x-truemed-api-key": "<apiKey>",
    "Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers, params=querystring)
print(response.json())

{
  "payouts": [
    {
      "amount": 1500.75,
      "date": "2024-05-05",
      "payout_id": "po_1Hh1YZ2eZvKYlo2C3X9a7b8d"
    },
    {
      "amount": 2300,
      "date": "2024-05-15",
      "payout_id": "po_1Hh2AB2eZvKYlo2C7X4b9c0f"
    },
    {
      "amount": 1750.5,
      "date": "2024-05-25",
      "payout_id": "po_1Hh3CD2eZvKYlo2C9Y7d1e2g"
    }
  ],
  "pagination": {
    "count": 3,
    "current_page": 1,
    "last_page": 1,
    "page_size": 30
  }
}

Returns a paginated list of payouts 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

Number of results per page. Defaults to 30. Maximum 1000.

start_datedateRequired

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

end_datedateRequired

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

Response

Successful response

payoutslist of objects

List of payout data for the requested period.

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