Retrieve a collection of pay-in payments
GET/api/payin_transaction_details
This API endpoint has been purposefully crafted to gather a compilation of pay-in payments, with a specific emphasis on acquiring all the latest pay-in transactions associated with a designated account.
Request
Query Parameters
page integer
Default value: 1
The collection page number
itemsPerPage integer
Possible values: <= 50
Default value: 30
The number of items per page
pagination boolean
Enable or disable pagination
executionDate string
Select transactions by transaction execution date
currency string
amount[lt] string
amount[lte] string
amount[gt] string
amount[gte] string
order[id] string
Possible values: [ASC, DESC]
Sort the results by the specified field
Responses
- 200
- 401
- 403
OK - The request was processed successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
id integer
currency string
amount string
executionDate stringnull
comment stringnull
subType string
Possible values: [pay_in, returned_payment]
payerName stringnull
qrReference stringnull
isInstant boolean
[
{
"id": 1,
"currency": "CHF",
"amount": "100.00",
"executionDate": "2023-01-01T00:00:00+00:00",
"comment": "Comment",
"subType": "pay_in",
"payerName": "Name of the payer",
"qrReference": "QR reference",
"isInstant": true
}
]
Unauthorised -- Your access token is wrong.
- application/json
- Schema
- Example (from schema)
Schema
type string
title string
detail string
{
"type": "string",
"title": "string",
"detail": "string"
}
Forbidden -- Access to the requested resource or action is forbidden.
- application/json
- Schema
- Example (from schema)
Schema
type string
title string
detail string
{
"type": "string",
"title": "string",
"detail": "string"
}
Loading...