Query

get

https://connect.api.shine.fr/transactions/query

Query and retrieve a list of transactions

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

bankAccountId

string

required

Retrieve transactions for a specific Shine bank account

first

integer

≥ 1

Number of transactions to retrieve at the beginning of the window determined by the before/after cursor(s)

last

integer

≥ 1

Number of transactions to retrieve at the end of the window determined by the before/after cursor(s)

after

string

Optional param, to retrieve transactions after a specific cursor. Pass a transactionId.

before

string

Optional param, to retrieve transactions before a specific cursor. Pass a transactionId.

status

array of strings

Optional param, to retrieve transactions with a specific status

status

paymentMethod

array of strings

Payment method of the transaction

paymentMethod

feeType

array of strings

feeType of the transaction

feeType

category

string

enum

category of transaction. In particular, used to recover ATM transactions (CASH)

string

Optional param, to match the field 'title' or the field 'debtorFullName' if 'extendSearchToDebtorFullName' is true

type

array of strings

Optional filter, to retrieve only transactions matching a subset of types

type

hasReceipts

boolean

Optional filter, retrieve only transactions with or without receipts

isPersonal

boolean

Optional param, to filter transactions on the isPersonal field

isRefund

boolean

Optional filter, can be used to exclude transactions that are refunds

isHidden

boolean

Optional filter, retrieve only transactions with a given isHidden status

includeHidden

boolean

Optional filter, include hidden transactions in the output. Defaults to false, ignored if isHidden or includeHiddenFees true are passed

includeHiddenFees

boolean

Optional filter, include hidden fees transactions in the output. Defaults to false, ignored if isHidden is passed

extendSearchToDebtorFullName

boolean

Optional filter, to match 'q' with the field 'debtorFullName' in addition to the field 'title'. Defaults to false.

joinAdditionalFields

boolean

Optional filter, include fields from join tables. Default to true because mostly needed in our client apps

transactionAfter

integer

Optional filter, to retrieve only transactions initiated after this timestamp (large inequality)

transactionBefore

integer

Optional filter, to retrieve only transactions initiated before this timestamp (strict inequality)

minValue

number

Optional filter, to retrieve only transaction with a value larger than this value (large inequality)

maxValue

number

Optional filter, to retrieve only transaction with a value less than this value (large inequality)

companyUserId

string

Optional filter, to retrieve only transaction initiated by a company user

transactionId

array of strings

Optional param, to retrieve transactions from a list of transaction IDs

transactionId

Responses

200Success

defaultError