---
title: "Get Payment List"
method: GET
path: "/programs/{programCode}/accounts/{accountIdentifier}/billpayPayments"
tags: ["BillPay"]
---

# Get Payment List

`GET /programs/{programCode}/accounts/{accountIdentifier}/billpayPayments`

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.

## Path parameters

- `programCode` string, required
- `accountIdentifier` string, required

## Query parameters

- `startingPaymentDate` string
- `endingPaymentDate` string
- `statusFilter` string

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetAllPaymentResponse — Get All Payment Response – Contains a list of payments for the specified account. Used to provide detailed information about each payment, including payee, amount, status, schedule, and confirmation details.
  - `payments` Payment[], nullable — The list of payments for the account. Each item contains payment details such as payee identifier, payee name, payment identifier, status, amount, payment date, confirmation number, schedule, and frequency.
    - `payeeIdentifier` string, nullable — The unique identifier of the payee to whom the payment was made.
    - `payeeName` string, nullable — The name of the payee (merchant or person) associated with the payment.
    - `paymentIdentifier` string, nullable — The unique identifier assigned to the payment.
    - `paymentStatus` 'scheduled' | 'canceled' | 'failed' | 'inprocess' | 'processed' | 'unapproved', nullable — The status of the payment (e.g., Scheduled, Canceled, Failed, InProcess, Processed, UnApproved). See Gd.Bos.DataTransfer.Payment.PaymentStatus.
    - `amount` number, double — The amount paid to the payee.
    - `paymentDate` string, nullable — The date the payment is scheduled to be sent or was sent (format: yyyy-MM-dd).
    - `confirmationNumber` string, nullable — The confirmation number assigned to the payment for tracking and reference.
    - `paymentStartDate` string, nullable — The start date for recurring payments (format: yyyy-MM-dd). Null for one-time payments.
    - `paymentEndDate` string, nullable — The end date for recurring payments (format: yyyy-MM-dd). Null for one-time payments.
    - `frequencyType` string, nullable — The frequency type for the payment (e.g., "oneTime", "weekly", "monthly").
  - `responseDetails` ResponseDetail[], nullable — Required: A list of response details providing status codes, descriptions, and additional information about the result of the operation.
    - `code` integer — The primary status or error code for the response (e.g., 200 for success, 400 for validation error).
    - `subCode` integer, nullable — An optional subcode providing more granular detail about the response or error.
    - `description` string, nullable — A human-readable description of the response, error, or status.
    - `url` string, nullable — A URL linking to documentation or a web page with more information about the response code.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/greendot/apis/baas-apis.md) · [All operations](https://skmtc.net/greendot/apis/baas-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/greendot/baas-apis/revisions/666553766b78/schema)