Skip to main content

SepaMessageFilter

offsetinteger<int32>

Offset from which the results should be provided. Defaults to 0.

Possible values: >= 0

limitinteger<int32>

Limit of the number of objects returned by the server. Defaults to 20.

Possible values: >= 1 and <= 100

networkstring

Network for which the instructions should be received. SEPA is the only value allowed

directionstringrequired

Message Direction. Supported values are I (incoming) or O (outgoing)

dateFromstring

Start date from which the messages should be filtered. Accepted format: yyyy-MM-dd

dateTostring

End date up until which the messages should be filtered. Accepted format: yyyy-MM-dd

messageTypestring

Message type. Accepted values are pacs.008.001.02, pacs.004.001.02, pacs.003.001.02, camt.056.001.01, camt.029.001.03, pacs.004.001.09, pacs.009.001.08, pacs.008.001.10, pacs.004.001.11, camt.029.001.11, camt.056.001.10

messageIdstring

Message ID, representing the GrpHdr>>MsgId field of the message

originalMessageIdstring

Original Message ID, representing the underlying transaction info OrgnlMsgId

transactionsOffsetinteger<int32>

Offset from which the transactions should be provided. Defaults to 0. If the transactionsLimit or transactionsOffset is bigger than 0 then the messageId parameter has to be used as transactions pagination in only available for one message.

Possible values: >= 0

transactionsLimitinteger<int32>

Limit of the number of transactions returned by the server. Defaults to 10. If the transactionsLimit is 0 only message headers will be returned. If the transactionsLimit or transactionsOffset is bigger than 0 then the messageId parameter has to be used as transactions pagination in only available for one message.

Possible values: >= 0

paymentIdstring

Payment ID, id provided when creating a new payment

txIdstring

Transaction Id, id of the transaction, When provided in conjunction with direction, messageId, and messageType, it enables the retrieval of details for a single specific transaction. Note: If this combination of parameters is used, all other search filters will be bypassed.

SepaMessageFilter
{
  "offset": 0,
  "limit": 0,
  "network": "string",
  "direction": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "messageType": "string",
  "messageId": "string",
  "originalMessageId": "string",
  "transactionsOffset": 0,
  "transactionsLimit": 0,
  "paymentId": "string",
  "txId": "string"
}