API Reference

Get Payment List

get
https://example.com/programs//accounts//billpayPayments

Retrieves a list of payments for an account, with optional filtering and pagination.
• This endpoint allows you to view payments associated with the specified account.
• You can filter results by starting and ending payment dates, as well as by payment status.
• Pagination options are available via the offset and pageSize query parameters.
• The response includes payment details such as payee, amount, status, and payment dates.

Path Params
string
required

The program code associated with the partner implementation.

string
required

The unique identifier of the account for which to retrieve payments. Must be a valid GUID.

Query Params
string

The start date for filtering payments (optional, format: yyyy-MM-dd).

string

The end date for filtering payments (optional, format: yyyy-MM-dd).

string

The status filter for payments (optional).

Headers
string
required

The unique request identifier for idempotency and tracking. Must be provided in the X-GD-RequestId header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago