Skip to main content
POST
/
v1
/
cancellation-requests
/
{id}
:accept
Accept cancellation request
curl --request POST \
  --url https://api.pgw-sandbox.finventi.com/v1/cancellation-requests/{id}:accept \
  --header 'Content-Type: application/json' \
  --data '
{
  "feeAmount": 123
}
'
{
  "direction": "OUTBOUND",
  "id": 123,
  "reason": "DUPL",
  "sepaMessageId": "<string>",
  "status": "CANCELLATION_CREATED",
  "additionalComment": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "externalTransactionReferenceId": 123,
  "rejectionAdditionalReason": "<string>",
  "rejectionReason": "<string>",
  "rejectionSepaMessageId": "<string>",
  "returnTransactionId": 123,
  "sepaCancellationId": "<string>",
  "transactionId": 123
}

​
Overview

This endpoint accepts a payment cancellation request. The system creates a payment return transaction and sends a PACS.004 message to the original payment initiator.

​
Process Flow

  1. Validates the cancellation request
  2. Creates a payment return transaction
  3. Sends PACS.004 message to the original sender
  4. Updates the cancellation request status

Path Parameters

​
id
integer<int64>
required

Cancellation request ID.

Body

application/json
​
feeAmount
integer
required

Fee amount (cents) charged for cancellation request accept operation.
Should be less than transaction's amount.

Response

Cancellation request accepted

​
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
​
additionalComment
string

Cancellation request additional comment.

​
createdAt
string<date-time>

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

​
externalTransactionReferenceId
integer<int64>

ID of the external transaction reference from cancellation request, if present.

​
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.

​
sepaCancellationId
string

Cancellation request original ID (cxlId).

​
transactionId
integer<int64>

Cancellation request transaction ID.