Skip to main content
GET
List Provider Configs by Provider

Authorizations

Authorization
string
header
required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Path Parameters

providerId
string<uuid>
required

Identifier of the resource in Payrails.

Query Parameters

filter[status]
enum<string>

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

Available options:
enabled,
disabled,
deleted,
temporarilyDisabled
filter[paymentMethod]
enum<string>

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

Available options:
alexBankMa7fazty,
applePay,
audi2pay,
bankAccount,
card,
2c2p,
vietQR,
cibSmartWallet,
easypaisa,
etisalatCash,
fawryMobileWallet,
fawryPay,
googlePay,
jazzCash,
nbePhoneCash,
orangeCash,
payPal,
qnbEWallet,
weCash,
genericRedirect,
alfa,
konnect,
eftPro,
netBanking,
upi,
cashFreeWallet,
paytmWallet,
phonePe,
iDeal,
bancontact,
klarnaPayLater,
klarnaPayNow,
klarnaPayOverTime,
scalapay
filter[providerType]
enum<string>

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

Available options:
Fraud,
Payment,
Payout,
Vault,
NetworkOffers,
ThreeDS,
NetworkGateway,
NetworkToken,
Bin,
Data,
Dispute,
DisputeAlert,
Tax,
Billing
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
default:true

Whether to include the schema of the returned configs.

page[cursor]
string

Search collection items from that cursor. Cursor for paging results.

page[after]
string

Search collection items after that cursor. Cursor for paging results.

page[before]
string

Search collection items before that cursor. Cursor for paging results.

page[size]
integer<int32>

Length of the collection to search.

Response

Success.

results
object[]
required
Last modified on October 5, 2026