---
title: "List payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List payments

`GET /payments`

Get a list of the payments that your application has initiated on behalf of the user within the `start` and `end` time range.

>️ ℹ️ Time range defaults to the last 30 days.

For more details about payments see:
  - [📖 Making a payment guide](/docs/making-a-payment)
  - [📚 Payment lifecycle guide](/docs/making-a-payment#payment-lifecycle)
  - [📚 Payment webhooks](/docs/reference-webhooks#payment)

## Query parameters

- `start` string, date-time
- `end` string, date-time

## Headers

- `X-Akahu-Id` string, required

## Response `200`

Successful response.

- object
  - `success` boolean
  - `items` Payment[]
    - `_id` string — The Akahu Payment ID
    - `from` string — The Akahu Account ID of the source account
    - `to` object — Information about who this payment is to
      - `account_number` string — The NZ bank account number to whom this payment is made
      - `name` string — The name of the account holder of the destination account
    - `amount` number — How much money the payment is for
    - `meta` object — Payment metadata that you have specified
      - `destination` object — Metadata that will appear in the destination account
        - `particulars` string — The particulars you have specified for the destination account
        - `code` string — The code you have specified for the destination account
        - `reference` string — The reference you have specified for the destination account
      - `source` object — Metadata that will appear in the source account
        - `code` string — The code you have specified for the source account
        - `reference` string — The reference you have specified for the source account
    - `sid` string — Akahu's unique ID inserted into the particulars field
    - `status` 'READY' | 'PENDING_APPROVAL' | 'SENT' | 'PAUSED' | 'DECLINED' | 'CANCELLED' | 'ERROR' — Status of the payment: - `READY` → Initial state payment is ready to be processed. - `PENDING_APPROVAL` → Payment requires user approval before processing see the guide for more details. - `SENT` → Payment initiated with the user's bank and we've received confirmation that it has been accepted. - `PAUSED` → Payment is not yet ready to be processed. - `DECLINED` → Payment has been declined by the user's bank. - `CANCELLED` → Payment was cancelled. - `ERROR` → Internal Akahu error occurred. For more details see: - [📚 Payments guide](/docs/making-a-payment) - [📚 Payments lifecycle guide](/docs/making-a-payment#payment-lifecycle)
    - `status_text` string — If available, more information about the payment's staus
    - `final` boolean — If this payment has reached it's final state
    - `timeline` object[] — A timeline of events regarding this payment
      - `status` string — The payment's status at this time
      - `time` string, date-time — An ISO 8701 timestamp of when this event was created
      - `eta` string, date-time — An ISO 8701 timestamp of when Akahu expects the payment to arrive. Only present on events for `SENT` statuses.
    - `created_at` string, date-time — An ISO 8701 timestamp of when this payment was created
    - `updated_at` string, date-time — An ISO 8701 timestamp of when this payment was last updated by Akahu
    - `received_at` string, date-time — An ISO 8701 timestamp of when this payment was received by the destination account. This field will only be populated if the destination account is connected to Akahu.

## Other responses

- `400` — Your request was malformed or otherwise unacceptable. More details are provided under the `message` key in the response.
- `401` — You are not authorised to access this content.
- `403` — You are not allowed to access this content.
- `500` — An internal error has prevented us from processing the request. More detail may be supplied in the `message` key.

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)