---
title: "List external payments"
method: GET
path: "/v1/external_payments"
tags: ["External Payments"]
---

# List external payments

`GET /v1/external_payments`

List external payments

## Query parameters

- `category` 'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_TRANSFER'
- `financial_account_token` string, uuid
- `business_account_token` string, uuid
- `result` 'APPROVED' | 'DECLINED'
- `status` 'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED'
- `begin` string, date-time
- `ending_before` string
- `end` string, date-time
- `page_size` integer
- `starting_after` string

## Response `200`

OK

- ExternalPaymentsResponse
  - `data` ExternalPaymentResponse[], required
    - `status` 'PENDING' | 'SETTLED' | 'DECLINED' | 'REVERSED' | 'CANCELED' | 'RETURNED', required
    - `token` string, uuid, required — Unique identifier for the transaction
    - `created` string, date-time, required — ISO 8601 timestamp of when the transaction was created
    - `updated` string, date-time, required — ISO 8601 timestamp of when the transaction was last updated
    - `family` 'EXTERNAL_PAYMENT', required — EXTERNAL_PAYMENT - External Payment Response
    - `result` 'APPROVED' | 'DECLINED', required
    - `category` 'EXTERNAL_WIRE' | 'EXTERNAL_ACH' | 'EXTERNAL_CHECK' | 'EXTERNAL_FEDNOW' | 'EXTERNAL_RTP' | 'EXTERNAL_TRANSFER', required
    - `settled_amount` integer, required
    - `pending_amount` integer, required
    - `currency` string, required
    - `events` ExternalPaymentEvent[], required
      - `amount` integer, required
      - `type` 'EXTERNAL_WIRE_INITIATED' | 'EXTERNAL_WIRE_CANCELED' | 'EXTERNAL_WIRE_SETTLED' | 'EXTERNAL_WIRE_REVERSED' | 'EXTERNAL_WIRE_RELEASED' | 'EXTERNAL_ACH_INITIATED' | 'EXTERNAL_ACH_CANCELED' | 'EXTERNAL_ACH_SETTLED' | 'EXTERNAL_ACH_REVERSED' | 'EXTERNAL_ACH_RELEASED' | 'EXTERNAL_TRANSFER_INITIATED' | 'EXTERNAL_TRANSFER_CANCELED' | 'EXTERNAL_TRANSFER_SETTLED' | 'EXTERNAL_TRANSFER_REVERSED' | 'EXTERNAL_TRANSFER_RELEASED' | 'EXTERNAL_CHECK_INITIATED' | 'EXTERNAL_CHECK_CANCELED' | 'EXTERNAL_CHECK_SETTLED' | 'EXTERNAL_CHECK_REVERSED' | 'EXTERNAL_CHECK_RELEASED' | 'EXTERNAL_FEDNOW_INITIATED' | 'EXTERNAL_FEDNOW_CANCELED' | 'EXTERNAL_FEDNOW_SETTLED' | 'EXTERNAL_FEDNOW_REVERSED' | 'EXTERNAL_FEDNOW_RELEASED' | 'EXTERNAL_RTP_INITIATED' | 'EXTERNAL_RTP_CANCELED' | 'EXTERNAL_RTP_SETTLED' | 'EXTERNAL_RTP_REVERSED' | 'EXTERNAL_RTP_RELEASED', required
      - `result` 'APPROVED' | 'DECLINED', required
      - `detailed_results` DetailedResults[], required
      - `created` string, date-time, required
      - `token` string, uuid, required
      - `memo` string, required
      - `effective_date` string, date, required
    - `user_defined_id` string, nullable
    - `financial_account_token` string, uuid, required
    - `payment_type` 'DEPOSIT' | 'WITHDRAWAL', required
  - `has_more` boolean, required

## Other responses

- `400` — A parameter in the query given in the request does not match the valid queries for the endpoint.
- `401` — | | | |---|---| | User has not been authenticated | Invalid or missing API key | | API key is not active | The API key used is no longer active | | Could not find API key | The API key provided is not associated with any user | | Please provide API key in Authorization header | The Authorization header is not in the request | | Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly | | Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at [lithic.com/contact](https://lithic.com/contact) | | Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege | Reach out at [lithic.com/contact](https://lithic.com/contact) |
- `429` — Client has exceeded the number of allowed requests in a given time period. | | | |---|---| | Rate limited, too many requests per second | User has exceeded their per second rate limit | | Rate limited, reached daily limit | User has exceeded their daily rate limit | | Rate limited, too many keys tried | One IP has queried too many different API keys |

---

[API](https://skmtc.net/lithic-com/apis/lithic-developer-api.md) · [All operations](https://skmtc.net/lithic-com/apis/lithic-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lithic-com/lithic-developer-api/revisions/53ab5d4e2adb/schema)