Get a filtered list of transaction intents
GET/transaction-intents
Get a filtered list of transaction intents
Request
Query Parameters
Possible values: [ByFromToCreatedOn
, ByCustomer
, ActiveByCustomerAndMerchant
]
Default value: ByFromToCreatedOn
The min creation datetime of the entries to be returned, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
The max creation datetime of the entries to be returned, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
Default value: 10
The count of items to be returned (page size)
Possible values: [asc
, desc
]
The sort order of items to be returned
The customerId of the transaction intents to be returned. Required if the query type is ByCustomer*
The customerId of the transaction intents to be returned. Required if the query type is ActiveByCustomerAndMerchant
Responses
- 200
- 400
- 500
Successful response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
items
object[]
The id of the transaction
Possible values: <= 10000
The amount of the transaction
Possible values: [EUR
]
The currency code as ISO 4217 3-digit code (https://en.wikipedia.org/wiki/ISO_4217).
The unique id of the customer participating in the transaction. Available if type is Passthrough
Possible values: [PassthroughDeposit
, PassthroughWithdrawal
, CustomerToMerchantPassthrough
, MerchantToCustomerPassthrough
]
The type of the transaction intent, this corresponds to the type of the transaction created from the intent
Possible values: [Created
, PendingApproval
, Declined
, Pending
, Expired
, Cancelled
, Finalized
]
The current(last) state of the transaction intent.
The server-generated timestamp of the initial creation of the transaction record, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time
{
"items": [
{
"id": "40c7fe9f-3bf9-464a-8d3a-937db20f5dae",
"amount": 100,
"currency": "EUR",
"customerId": "111abc22-33de-4444-5555-111111111111",
"type": "PassthroughDeposit",
"state": "Created",
"createdOn": "2019-01-31T11:50:59Z"
}
]
}
Validation failed
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [Validation
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "Validation",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}
Unexpected technical error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: [GeneralErrorOccurred
]
The type of error
A short text describing the error
A link to the online documentation describing the error in detail
Identifies the conversation within which the error got generated
details
object
Contains additional details of the error
validationErrorReasons
object[]
A collection of Validation error details
name of filed that failed validation
error message
{
"code": "GeneralErrorOccurred",
"message": "string",
"moreInfo": "https://developer.example.com/ExampleService/v1.0/errors/validation",
"correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
"details": {
"validationErrorReasons": [
{
"fieldName": "customerId",
"errorMessage": "Value must not be empty"
}
]
}
}