List Provider Configs by Provider

get

https://api.staging.payrails.io/payment/providers/{providerId}/configs

Fetch a list of provider configs with a relationship to the provider.

Path Params

providerId

uuid

required

Identifier of the resource in Payrails.

Query Params

filter[status]

string

enum

Filter by provider config status to only find provider configs with this status.

Allowed:

filter[paymentMethod]

string

enum

Filter by payment method to only find active providers which support this payment method.

filter[providerType]

string

enum

Filter by provider type to only find active providers of a specific type, e.g. Vault.

filter[providerName]

string

Filter for a list of provider configs by provider name.

filter[accountName]

string

Filter for a list of provider configs by account name.

filter[accountDisplayName]

string

Filter for a list of provider configs by account display name.

filter[workspaceId]

string

Filter by Workspace ID.

includeSchema

boolean

Defaults to true

Whether to include the schema of the returned configs.

page[cursor]

string

Search collection items from that cursor.

page[after]

string

Search collection items after that cursor.

page[before]

string

Search collection items before that cursor.

page[size]

int32

Length of the collection to search.

Responses

Language

Credentials

Bearer

JWT

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

404Not Found.

429Too Many Requests.