Search & list Fraud checks

get

https://api.staging.payrails.io/payment/frauds

Fetch a list of fraud checks.

Query Params

includeInstrument

boolean

Defaults to false

Boolean indicating if the payment instrument should be included in the response.

includeHolderReference

boolean

Defaults to false

Boolean indicating if the holder reference should be included in the response.

filter[fraudId]

string

Filter for a list of fraud checks by ID.

filter[providerId]

string

Filter for a list of fraud checks by provider ID.

filter[providerConfigId]

string

Filter for a list of fraud checks by provider config ID.

filter[providerReference]

string

Filter for a list of fraud checks by provider reference.

filter[holderId]

string

Filter for a list of fraud checks by holder ID.

filter[holderReference]

string

Filter for a list of fraud checks by holder reference.

filter[workflowExecutionId]

string

Filter for a list of fraud checks by workflow execution ID.

filter[status]

string

Filter for a list of fraud checks by latest payment status.

filter[decision]

string

Filter for a list of fraud checks by any decision.

filter[instrumentId]

string

Filter for a list of fraud checks by instrument ID.

filter[instrumentBin]

string

Filter for a list of fraud checks by instrument BIN.

filter[instrumentSuffix]

string

Filter for a list of fraud checks by instrument suffix.

filter[instrumentNetwork]

string

Filter for a list of fraud checks by card network.

filter[instrumentIssuer]

string

Filter for a list of fraud checks by instrument issuer.

filter[instrumentIssuerCountry]

string

Filter for a list of fraud checks by instrument issuer country.

filter[instrumentFutureUsage]

string

Filter for a list of fraud checks by instrument future usage.

filter[workspaceId]

string

Filter by Workspace ID.

filter[createdAt]

string

Filter by createdAt.

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

Loading…

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

429Too Many Requests.