# Get all payment methods and include pre-authorized payment tokens when available

**GET /payment-methods?include=paymentTokens**

This request returns all payment methods with included pre-authorized tokens.</br></br>
The list will contain the pre-authorized amount (incl. currency), the purpose PRNs, all information about the payment method, and the paymentToken that can be used to complete the payment.</br> If no payment method is associated with a pre-authorized token, the result will contain only the payment methods.</br></br>


## Servers
- Production server (preview release 2024-4): https://api.pace.cloud/pay/2024-4 (Production server (preview release 2024-4))


## Authentication methods
- OAuth2
- Oidc


## Parameters


### Query parameters
- **include** (string)

- **filter[purpose]** (string)
  When provided allows filtering by PACE resource name(s). Only payment methods suitable for the given purpose are returned.


## Responses
### 200
All the payment methods with pre-authorized amounts and purpose PRNs.

#### Body: application/vnd.api+json (object)
- **data** (array[object])

- **included** (array[object])


### 401
OAuth token missing or invalid or a linked identity is missing.

Linked identity missing is a special case where you need to make sure that
the user has additionally logged in / authorized with a third-party.

This is not relevant for most use-cases.

The specific error code that identifies a missing linked identity is `missing-linked-identity`

Example:

```
  {
      "errors": [
          {
              "id": "cbgmhslmp1o9or9kh1p0",
              "title": "Missing linked identity for authorized access",
              "detail": "Linked identity is needed to access this resource, please check why the user does not have a linked identity",
              "status": "401",
              "code": "missing-linked-identity"
          }
      ]
  }
```


#### Body: application/vnd.api+json (object)
- **errors** (array[object])


### 406
The specified accept header is invalid

#### Body: application/vnd.api+json (object)
- **errors** (array[object])


### 422
The request was well-formed but was unable to be followed due to semantic errors.

#### Body: application/vnd.api+json (object)
- **errors** (array[object])


### 500
Internal server error

#### Body: application/vnd.api+json (object)
- **errors** (array[object])



[Powered by Bump.sh](https://bump.sh)