Sign in

v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
BillPay

Get Payment List

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

get/programs/{programCode}/accounts/{accountIdentifier}/billpayPayments

Path parameters

programCodestring required

The program code associated with the partner implementation.

accountIdentifierstring required

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

Query parameters

startingPaymentDatestring

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

endingPaymentDatestring

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

statusFilterstring

The status filter for payments (optional).

Headers

X-GD-RequestIdstring required

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

Response

OK