Search Payments by Program

post

https://devapi.qolopay.com/api/{version}/payments/search

Returns payments scoped to the supplied program

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version

string

required

Body Params

The search criteria. program_guid is required.

Search request for the "Search Payments by Program" API.

program_guid

uuid

required

Unique Program Identifier on the Qolo Platform

person_guid

uuid | null

Person unique identifier on the platform

account_guid

uuid | null

Account unique identifier on the platform

payment_status

array of strings | null

List of payment statuses to filter on - ACTIVE, COMPLETED, PAID, PENDING, RECURRING

payment_status

schedule_status

array of strings | null

List of payment schedule statuses to filter on - ACTIVE, EXPIRED, KILLED, SUSPENDED

schedule_status

request_code

array of strings | null

List of request codes to filter on - PT_ACCOUNTDISB, PT_CLEARING, PT_COLLECTION, PT_CR_REPAYMENT, PT_MANUALMEMO, PT_RECURRING, PT_SCH_TRANSFER, PT_TOPUP

request_code

start_index

int32

1 to 1000

1-based index used for pagination of the result. Defaults to 1.

limit

int32

1 to 1000

Maximum number of payment records to return. Defaults to 10.

Responses

500

Server Error

200Returns the matching payments

400Bad request

401Unauthorized

404Program not found / not authorized