Search & list payments

get

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

Query Params

includeInstrument

boolean

Defaults to false

includeProviderAccountDisplayName

boolean

Defaults to false

includePaymentToken

boolean

Defaults to false

includeHolderReference

boolean

Defaults to false

filter[paymentId]

string

filter[providerId]

string

filter[providerConfigId]

string

filter[providerReference]

string

filter[holderId]

string

filter[holderReference]

string

filter[transactionReference]

string

filter[merchantReference]

string

filter[processingType]

string

filter[captureMode]

string

filter[status]

string

filter[anyReference]

string

filter[tokenType]

string

enum

Allowed:

filter[instrumentId]

string

filter[instrumentBin]

string

filter[instrumentSuffix]

string

filter[instrumentNetwork]

string

filter[instrumentLocalNetwork]

string

filter[instrumentIssuer]

string

filter[instrumentIssuerCountry]

string

filter[instrumentFutureUsage]

string

filter[authorizationFailureResult]

string

filter[workspaceId]

string

filter[paymentMethodType]

string

filter[customerEmail]

string

filter[createdAt]

string

page[cursor]

string

page[after]

string

page[before]

string

page[size]

int32

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Choose an example:

application/json

200Success.

400Bad Request.

401Unauthorized.

403Insufficient Scope.

429Too Many Requests.