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

# Get Payment

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

Retrieves the details of a scheduled bill payment for the specified account and payment identifier. <br/>• This endpoint returns payment information such as payee, status, amount, schedule, delivery, memo, and confirmation details.

## Path parameters

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

## Headers

- `X-GD-RequestId` string, required

## Response `200`

OK

- GetPaymentResponse — Get Payment Response – Contains the details of a specific scheduled bill payment. Used to provide payment information such as payee, status, amount, schedule, delivery, memo, and confirmation details for a given payment identifier.
  - `payment` PaymentDetail — Payment Detail – Represents detailed information about a specific bill payment. Used to provide payment attributes such as payee, status, amount, schedule, delivery, memo, note, confirmation, and frequency in payment detail responses.
    - `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.
    - `paymentStatus` string, nullable — The status of the payment (e.g., "scheduled", "processed", "failed", "canceled").
    - `amount` number, double, nullable — 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).
    - `deliveryDate` string, nullable — The date the payment is expected to be delivered to the payee (format: yyyy-MM-dd).
    - `paymentMemo` string, nullable — An optional memo included with the payment.
    - `note` string, nullable — An optional note for the payment.
    - `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)