# List all stripe payments

To [fetch](https://docs.commercelayer.io/core/fetching-resources) a collection of stripe payments, send a `GET` request to the `/api/stripe_payments` endpoint.

## Request

**GET** <https://yourdomain.commercelayer.io/api/stripe\\_payments>

### **Example**

{% tabs %}
{% tab title="Request" %}
The following request fetches a collection of stripe payments:

```shell
curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/stripe_payments/' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'
```

{% endtab %}

{% tab title="Response" %}
On success, the API responds with a `200 OK` status code, returning a paginated collection of resource objects:

```json
{
  "data": [
    {
      "id": "XAyRWNUzyN",
      "type": "stripe_payments",
      "links": {
        "self": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN"
      },
      "attributes": {
        "stripe_id": "pi_1234XXX",
        "client_secret": "pi_1234XXX_secret_5678YYY",
        "connected_account": "acct_xxxx-yyyy-zzzz",
        "charge_id": "ch_1234XXX",
        "publishable_key": "pk_live_xxxx-yyyy-zzzz",
        "on_behalf_of": "xxxx-yyyy-zzzz",
        "transfer_group": "xxxx-yyyy-zzzz",
        "options": {
          "customer": "cus_xxx",
          "payment_method": "pm_xxx"
        },
        "payment_method": {
          "id": "pm_xxx"
        },
        "mismatched_amounts": false,
        "return_url": "https://yourdomain.com/thankyou",
        "receipt_email": "john@example.com",
        "payment_instrument": {
          "issuer": "cl bank",
          "card_type": "visa"
        },
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANY-EXTERNAL-REFEFERNCE",
        "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "order": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/relationships/order",
            "related": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/order"
          }
        },
        "payment_gateway": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/relationships/payment_gateway",
            "related": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/payment_gateway"
          }
        },
        "versions": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/relationships/versions",
            "related": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/versions"
          }
        },
        "event_stores": {
          "links": {
            "self": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/relationships/event_stores",
            "related": "https://yourdomain.commercelayer.io/api/stripe_payments/XAyRWNUzyN/event_stores"
          }
        }
      },
      "meta": {
        "mode": "test",
        "organization_id": "xRRkjDFafe",
        "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
      }
    },
    {
      "other": "... 9 stripe_payments (first page)"
    }
  ],
  "meta": {
    "record_count": 140,
    "page_count": 14
  },
  "links": {
    "first": "https://yourdomain.commercelayer.io/api/stripe_payments?page[number]=1&page[size]=10",
    "next": "https://yourdomain.commercelayer.io/api/stripe_payments?page[number]=2&page[size]=10",
    "last": "https://yourdomain.commercelayer.io/api/stripe_payments?page[number]=14&page[size]=10"
  }
}
```

{% endtab %}
{% endtabs %}

Remember that when you fetch a list of resources you get [paginated](https://docs.commercelayer.io/core/pagination) result.

### Sortable fields

The list of stripe payments can be [sorted](https://docs.commercelayer.io/core/sorting-results) by the following fields:

#### Attributes

* `id`
* `created_at`
* `updated_at`
* `reference`
* `reference_origin`

#### Relationships

* `order`

### Filterable fields

The list of stripe payments can be [filtered](https://docs.commercelayer.io/core/filtering-data) by the following fields:

#### Attributes

* `id`
* `created_at`
* `updated_at`
* `reference`
* `reference_origin`
* `metadata`
