Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
ProviderConfigs

List Provider Configs by Provider

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

get/payment/providers/{providerId}/configs

Path parameters

providerIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

filter[status]'enabled' | 'disabled' | 'deleted' | 'temporarilyDisabled'

Status of the provider config.

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

filter[paymentMethod]'alexBankMa7fazty' | 'applePay' | 'audi2pay' | 'bankAccount' | 'card' | 'cibSmartWallet' | 'easypaisa' | 'etisalatCash' | 'fawryMobileWallet' | 'fawryPay' | 'googlePay' | 'jazzCash' | 'nbePhoneCash' | 'orangeCash' | 'payPal' | 'qnbEWallet' | 'weCash' | 'genericRedirect' | 'alfa' | 'konnect' | 'eftPro' | 'netBanking' | 'upi' | 'cashFreeWallet' | 'paytmWallet' | 'phonePe'

Represents the payment method type.

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

filter[providerType]'Fraud' | 'Payment' | 'Payout' | 'Vault' | 'NetworkOffers' | 'ThreeDS' | 'NetworkGateway' | 'NetworkToken' | 'Bin' | 'Data' | 'Dispute' | 'DisputeAlert' | 'Tax'

Provider type.

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.

includeSchemaboolean

Whether to include the schema of the returned configs.

page[cursor]string

Cursor for paging results.

Search collection items from that cursor.

page[after]string

Cursor for paging results.

Search collection items after that cursor.

page[before]string

Cursor for paging results.

Search collection items before that cursor.

page[size]integer

Length of the collection to search.

Response

Success.