# List payment sources

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Eventually Consistent](/docs/api/read-consistency)

Lists all the payment sources

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/payment_sources \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode "type[is]"="CARD"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = PaymentSource.List()
		.Limit(3)
		.Type().Is(TypeEnum.Card)
		.Request();

foreach (var listItem in result.List){
  PaymentSource paymentSource = listItem.PaymentSource;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    paymentsourceAction "github.com/chargebee/chargebee-go/v3/actions/paymentsource"
    "github.com/chargebee/chargebee-go/v3/models/paymentsource"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := paymentsourceAction.List(&paymentsource.ListRequestParams{
        Limit : chargebee.Int32(3),
        Type : &filter.EnumFilter{
            Is : "card",
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            PaymentSource := res.List[idx].PaymentSource
        }
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.PaymentSourceListRequest{
    Limit : chargebee.Int32(3),
    Type : &chargebee.EnumFilter{
        Is : "card",
    },
}
  res, err := client.PaymentSource.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            PaymentSource := res.List[idx].PaymentSource
        }
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        ListResult result = PaymentSource.list()
            .limit(3)
            .type().is(Type.CARD)
            .request();

        for (ListResult.Entry entry : result) {
            PaymentSource paymentSource = entry.paymentSource();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.paymentSource.PaymentSource;
import com.chargebee.v4.models.paymentSource.params.PaymentSourceListParams;
import com.chargebee.v4.models.paymentSource.responses.PaymentSourceListResponse;
import java.util.List;

public class PaymentSourceList {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        PaymentSourceListParams params = PaymentSourceListParams.builder()
            .limit(3)
            .type()
            .is(PaymentSourceListParams.Type.CARD)
            .build();

        PaymentSourceListResponse response = client.paymentSources().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.paymentSource.list({
        limit: 3,
        type: {
            is: "card"
        }
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const paymentSource = entry.payment_source;
    });
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->paymentSource()->all([
    "limit" => 3,
    "type" => [
        "is" => "card"
    ]
]);
foreach($result->list as $entry) {
    $paymentSource = $entry->payment_source;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.PaymentSource.list(
    cb_client.PaymentSource.ListParams(
        limit=3,
        type=Filters.EnumFilter(IS=chargebee.Type.CARD)
    )
)
for entry in entries.list:
    payment_source = entry.payment_source
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

list = ChargeBee::PaymentSource.list({
  :limit => 3,
  "type[is]" => "card"
})

list.each do |entry|
  payment_source = entry.payment_source
end
```

## Sample Response

```json
{
  "list": [
    {
      "payment_source": {
        "card": {
          "brand": "visa",
          "expiry_month": 12,
          "expiry_year": 2022,
          "first_name": "Richard",
          "funding_type": "not_known",
          "iin": "411111",
          "last4": "1111",
          "last_name": "Fox",
          "masked_number": "************1111",
          "object": "card"
        },
        "created_at": 1517487242,
        "customer_id": "__test__XpbTXGTSRp4SZ5En",
        "deleted": false,
        "gateway": "pin",
        "gateway_account_id": "gw___test__5SK2lMpwSRp4Sb831",
        "id": "pm___test__XpbTXGTSRp4TUQEq",
        "object": "payment_source",
        "reference_id": "LHqS22OIh4y61Af9CXHicQFCfuD",
        "resource_version": 1517487242630,
        "status": "valid",
        "type": "card",
        "updated_at": 1517487242
      }
    },
    {..}
  ],
  "next_offset": "[\"1517487233000\",\"209000000107\"]"
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/payment_sources

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

- `subscription_id` (optional, string, max chars=50)
  Unique subscription identifier that helps to retrieve the payment source of a subscription which has `mandate` associated to it.

- `include_deleted` (optional, boolean, default=false)
  Indicates whether to include deleted objects in the list. The deleted objects have the attribute '`deleted` ' as '`true` '.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `payment_source` (Payment source object)
  Resource object representing payment\_source