Get a list of payment providers

get/payment-providers
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
type
string (StringFilterParam)

Filter by payment type

Example: type=xyz | in:x,y | like:xyz
contractOwnerId
integer <int64> (IdParam) >= 1

Filter by contract owner id

Example: contractOwnerId=1
instantBankPayments
string (BooleanFilterParam)

Filter by those payment providers that support instant bank payments

Example: instantBankPayments=true | false
retryIfPossible
string (BooleanFilterParam)

Filter by those payment provider's retryIfPossible flag

Example: retryIfPossible=true | false
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "type": "CHEQUE",
    • "name": "string",
    • "directDebitWithName": "string",
    • "status": "ACTIVE",
    • "creditorIdentifier": "string",
    • "instantBankPayments": false,
    • "retryIfPossible": false,
    • "contractOwnerIds": [
      • 1
      ]
    }
]