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

# List sources

`GET /sources/`

## Query parameters

- `page` integer
- `page_size` integer
- `customer` string
- `gateway` string
- `usage` 'single' | 'reusable'
- `status` string
- `id` integer

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated source list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Source[], required — The items in the current page.
    - `id` integer
    - `customer` string, nullable — Customer ID. Required for reusable sources.
    - `gateway` string, required — Gateway ID (e.g. `transbank`, `stripe`, `ach_transfer`).
    - `usage` 'single' | 'reusable'
    - `status` 'failed' | 'pending' | 'requires_authorization' | 'waiting_authorization' | 'consumed' | 'chargeable' | 'finalized'
    - `amount` number, nullable
    - `description` string, nullable
    - `return_url` string, uri, nullable — URL the payer is sent to after a redirect-flow tokenization.
    - `gateway_data` object — Gateway-specific payload (e.g. redirect form fields, token).
    - `client` object — Client metadata captured at creation time (IP, user agent, etc.).
    - `metadata` object
    - `card` SourceCard — Card details when the source represents a tokenized card.
      - `brand` string
      - `last4` string
      - `exp_month` integer, nullable
      - `exp_year` integer, nullable
    - `test_mode` boolean
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)