Skip to main content
GET
/
v1
/
cancellation-requests
Get cancellation requests list
curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v1/cancellation-requests
[
  {
    "direction": "OUTBOUND",
    "id": 123,
    "reason": "DUPL",
    "sepaMessageId": "<string>",
    "status": "CANCELLATION_CREATED",
    "type": "CANCELLATION",
    "additionalComment": "<string>",
    "datetime": "2023-11-07T05:31:56Z",
    "method": "SEPA",
    "rejectionAdditionalReason": "<string>",
    "rejectionReason": "<string>",
    "rejectionSepaMessageId": "<string>",
    "returnTransactionId": 123,
    "transactionId": 123
  }
]

Query Parameters

​
transactionId
string

A filter by cancellation request transaction ID.

​
status
enum<string>

A filter by cancellation request status. Multiple values are supported e.g. status=CANCELLATION_CREATED&status=CANCELLATION_IN_PROGRESS

Available options:
CANCELLATION_CREATED,
CANCELLATION_IN_PROGRESS,
CANCELLATION_REFUSED,
PAYMENT_RETURNED,
PROCESSING_FAILED,
REFUSING,
RETURNING,
CANCELLATION_COMPLETED,
CANCELLATION_REJECTED,
CANCELLATION_ACCEPTED
​
dateFrom
string

A filter by cancellation request date time from (ISO-8601 format).

Example:

"2023-10-24T12:00:00Z"

​
dateTo
string

A filter by cancellation request date time to (ISO-8601 format).

Example:

"2023-10-24T12:00:00Z"

​
method
enum<string>

A filter by transaction method. Multiple values are supported e.g. schema=SEPA&schema=INST

Available options:
SEPA,
INST,
SDD,
SWIFT
​
direction
enum<string>

A filter by transaction direction.

Available options:
OUTBOUND,
INBOUND
​
type
enum<string>

A filter by cancellation request type.

Available options:
CANCELLATION

Response

Returned cancellation requests list

​
direction
enum<string>
required

Cancellation request transaction direction.

Available options:
OUTBOUND,
INBOUND
​
id
integer<int64>
required

Cancellation request ID.

​
reason
enum<string>
required

Cancellation request reason.

Available options:
DUPL,
CUST,
FRAD,
TECH,
AC03,
AM09,
AGNT,
COVR,
CURR,
CUTA,
DS24,
FRNA,
FRTR,
INDM,
SYAD,
UPAY,
AC01,
AC04,
AC06,
AC13,
AG01,
AG02,
AM01,
AM04,
AM05,
CNOR,
DNOR,
MD01,
MD02,
MD07,
MS02,
MS03,
RC01,
RR01,
RR02,
RR04,
SL01,
BE05,
FF01,
DT01,
ED05,
PY01
​
sepaMessageId
string
required

Cancellation request sepa message ID.

​
status
enum<string>
required

Cancellation request status.

Available options:
CANCELLATION_CREATED,
CANCELLATION_IN_PROGRESS,
CANCELLATION_REFUSED,
PAYMENT_RETURNED,
PROCESSING_FAILED,
REFUSING,
RETURNING,
CANCELLATION_COMPLETED,
CANCELLATION_REJECTED,
CANCELLATION_ACCEPTED
​
type
enum<string>
required

Cancellation request type.

Available options:
CANCELLATION
​
additionalComment
string

Cancellation request additional comment.

​
datetime
string<date-time>

Cancellation request creation date time (ISO-8601 format).

​
method
enum<string>

Cancellation request transaction method.

Available options:
SEPA,
INST,
SDD,
SWIFT
​
rejectionAdditionalReason
string

Cancellation request rejection additional reason.

​
rejectionReason
string

Cancellation request rejection reason.

​
rejectionSepaMessageId
string

Cancellation request rejection sepa message ID.

​
returnTransactionId
integer<int64>

Cancellation request return transaction ID.

​
transactionId
integer<int64>

Cancellation request transaction ID.