Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Payment.Report

Get Payment Report

post/online/RivhitOnlineAPI.svc/Payment.Report

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

pay_codeinteger nullable

The Payment Type.

Range: 1 to 99 Default: No

from_production_datestring date

The issue Date to Start Filter.

~ combine with to_production_date Format: dd-MM-yyyy Default: No

to_production_datestring date

The issue Date to End Filter.

~ combine with from_production_date Format: dd-MM-yyyy Default: No

from_value_datestring date nullable

The Due Date to Start Filter.

~ combine with to_value_date Format: dd-MM-yyyy Default: No

to_value_datestring date nullable

The Due Date to End Filter.

~ combine with from_value_date Format: dd-MM-yyyy Default: No

crmUserIdinteger nullable

CRM User Id.

Range: 0 to 99999 Default: Rivhit user settings

projectIdinteger nullable

Project Id Serial Number (Rivhit system).

Range: 0 to 999999999 Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "pay_code": 4,
  "from_production_date": "01-05-2026",
  "to_production_date": "05-05-2026",
  "from_value_date": "01-01-2026",
  "to_value_date": "31-12-2026"
}

Response

Success - Receipt List Returned

error_codeinteger

The Response Error/Status Number (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.