Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Providers

Search & list providers

Fetch a list of providers.

get/payment/providers

Query parameters

filter[status]'active' | 'inactive'

Status of the provider.

Filter by status.

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

Provider type.

Filter by type.

filter[name]string

Filter for a list of providers by name.

filter[displayName]string

Filter for a list of providers by display name.

filter[createdAt]string
Example:[2026-04-01T00:00:00Z,2026-05-01T00:00:00Z)

Filter by createdAt field using interval notation.

1973-02-03T04:32:11.596Z - exact date value

(1973-02-03T04:32:11.596Z - after the date excluding it

[1973-02-03T04:32:11.596Z - after the date including it

1973-02-03T04:32:11.596Z) - before the date excluding it

1973-02-03T04:32:11.596Z] - before the date including it

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding both

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates excluding on the left

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding on the right

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates including both.

filter[updatedAt]string

Filter by updatedAt field. The value should represent a range one of the following formats (1973-02-03T04:32:11.596Z - after the date excluding it

[1973-02-03T04:32:11.596Z - after the date including it

1973-02-03T04:32:11.596Z) - before the date excluding it

1973-02-03T04:32:11.596Z] - before the date including it

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding both

(1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates excluding on the left

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z) - between two dates excluding on the right

[1973-02-03T04:32:11.596Z,1973-04-03T03:20:11.436Z] - between two dates including both.

Example:1978-01-04T19:33:19.261Z

Filter by updatedAt.

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.