Skip to content
/
Get Payment

Get Payment

Request

Security
x-api-key and a-api-key
Path
payment_idintegerrequired
curl -i -X GET \
  'https://api.pracsuite.com/v1/payment/{payment_id}' \
  -H 'a-api-key: YOUR_API_KEY_HERE' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful

Bodyapplication/json
row_numintegerread-only
total_rowsintegerread-only
tenant_idinteger
payment_idinteger
client_idinteger
account_idinteger
payment_timestring^\d{4}-\d{2}-\d{2}[Tt]\d{2}:\d{2}:\d{2}$

ISO 8601 local datetime in the tenant's timezone.

Example:"2026-01-01T12:05:30"
payment_typestring
totalnumber, (double)
allocatednumber, (double)
business_idinteger
user_idinteger
card_typestring
notesstring
payer_idinteger
createdstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
updatedstring, (date-time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6...

RFC 3339 UTC date-time (Z) with microsecond precision.

Example:"2020-09-12T11:09:42.687393Z"
created_by_user_idinteger
updated_by_user_idinteger
payment_itemsArray of objects
Response
{
  "row_num": 0,
  "total_rows": 0,
  "links": {
    "self": "https://api.pracsuite.com/v1/payment/1"
  },
  "tenant_id": 0,
  "payment_id": 0,
  "client_id": 0,
  "account_id": 0,
  "payment_time": "2026-01-01T12:05:30",
  "payment_type": "string",
  "total": 0.1,
  "allocated": 0.1,
  "business_id": 0,
  "user_id": 0,
  "card_type": "string",
  "notes": "string",
  "payer_id": 0,
  "created": "2020-09-12T11:09:42.687393Z",
  "updated": "2020-09-12T11:09:42.687393Z",
  "created_by_user_id": 0,
  "updated_by_user_id": 0,
  "payment_items": [
    { … }
  ]
}