Find claims

get

https://nightly-pix.btcore.app/dict/claims

Gets list of claims from the financial institution

Query Params

ispb

string

length between 8 and 8

Filters the search by giving a specific ispb

donor

boolean

Filters only claims that have the current PSP as donor

taxId

string

length between 11 and 14

Retrieves only claims in which the taxId provided matches the taxId of the account owner or the counterpart

externalId

string

Retrieves only claims associated with the account with the given externalId

accountNumber

string

Retrieves only claims associated with the account with the given accountNumber

branch

string

Retrieves only claims associated with the account with the given branch

claimer

boolean

Filters only claims that have the current PSP as claimer

status

string

enum

Filters only claims with a given status

Allowed:

type

string

enum

Filters only claims with a given type

Allowed:

resolutionPeriodEndAfter

string

Retrieves only claims whose resolutionPeriodEnd is equal to or greater than the provided date

resolutionPeriodEndBefore

string

Retrieves only claims whose resolutionPeriodEnd is less than or equal to the provided date

completionPeriodEndAfter

string

Retrieves only claims whose completionPeriodEnd is equal to or greater than the provided date

completionPeriodEndBefore

string

Retrieves only claims whose completionPeriodEnd is less than or equal to the provided date

skip

integer

≥ 0

Pagination option for skiping a given number of results

limit

integer

≥ 1

Pagination element to limit the result array for a given length

orderBy

string

enum

Sorts query results by the given field

order

string

enum

Sorts query results according to the order provided

Allowed:

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401Unauthorized