Get paginated cancellation requests

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v2/cancellation-requests

{
  "meta": {
    "amount": 123,
    "limit": 123,
    "offset": 123
  },
  "result": [
    {
      "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
    }
  ]
}

GET

cancellation-requests

curl --request GET \
  --url https://api.pgw-sandbox.finventi.com/v2/cancellation-requests

{
  "meta": {
    "amount": 123,
    "limit": 123,
    "offset": 123
  },
  "result": [
    {
      "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

limit

string

A limit on the number of objects returned per page. The default is 10 items.

offset

string

Specifies the starting position for retrieving items in paginated results. The default is 0 items.

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

sort

string

A sort by id, transactionId, datetime fields. Multiple values are accepted. Example values: id,desc; datetime,desc

Response

Returned paginated cancellation requests

Getting Started

Account Management

SEPA Instant

SEPA Direct Debit

SWIFT Payments

Payment Information

Nostro Accounts

Bank Information

Webhooks

Get paginated cancellation requests

Query Parameters

Response