# Get a list of payment providers

Endpoint: GET /payment-providers
Version: 1.37
Security: bearerAuth

## Query parameters:

  - `page` (integer, required)
    Page of results to show
    Example: 1

  - `pageSize` (integer, required)
    Results to return per page
    Example: 100

  - `sort` (string)
    Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
    Example: "id,name | name:desc"

  - `fields` (string)
    Comma-delimited list of the field(s) to return if only a subset is required
    Example: "id,name"

  - `type` (string)
    Filter by payment type
    Example: "xyz | in:x,y | like:xyz"

  - `contractOwnerId` (integer)
    Filter by contract owner id
    Example: 1

  - `instantBankPayments` (string)
    Filter by those payment providers that support instant bank payments
    Example: "true | false"

  - `retryIfPossible` (string)
    Filter by those payment provider's retryIfPossible flag
    Example: "true | false"

## Response 200 fields (application/json):

  - `id` (integer)
    Payment Provider identifier
    Example: 1

  - `type` (string, required)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `name` (string, required)
    Payment provider name

  - `directDebitWithName` (string)
    Payment provider direct debit name

  - `status` (string, required)
    Payment provider status
    Enum: "ACTIVE", "INACTIVE"

  - `creditorIdentifier` (string)
    Payment provider creditor identifier

  - `instantBankPayments` (boolean)
    Does this payment provider support instant bank payments

  - `retryIfPossible` (boolean)
    Payment provider will retry the payment if possible

  - `acceptExternalPayments` (boolean)
    Payment provider will accept payment events that originated outside of the system

  - `contractOwnerIds` (array, required)
    Contract owner identifiers
    Example: [1]

  - `syncInstantBankPaymentsWithMandateCreation` (boolean)
    If a Go Cardless mandate is created as part of an instant bank payment billing flow, Elevate will automatically treat the instant payment as an upfront credit on the customer’s account


## Response 400 fields

## Response 401 fields

## Response 403 fields