POST api/payments/refunds/{refundPaymentId}/confirm

Confirms that the terminal made the refund: marks it processed, at the server's current time, and stores the terminal's reference on the refund payment. Responses: 200 with the refund. 404 if the refund or its payment doesn't exist.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
refundPaymentId

The refund's RefundPaymentId.

 globally unique identifier

Required

Body Parameters

The terminal's reference for the refund.

PaymentRefundConfirmationDT
NameDescriptionTypeAdditional information
PaymentReference

The terminal's transaction reference for the refund.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "paymentReference": "sample string 1"
}

Response Information

Resource Description

The refund, now processed.

PaymentRefundDT
NameDescriptionTypeAdditional information
Url

string

None.
RefundPaymentId

globally unique identifier

None.
OriginalPaymentId

globally unique identifier

None.
Processed

boolean

None.
ProcessedDateTimeStamp

date

None.
IsSaved

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "url": "sample string 1",
  "refundPaymentId": "ca0b782a-7b2a-4b30-8734-c1b2617cec35",
  "originalPaymentId": "590871ff-6dfb-4e75-9057-43a0397a2662",
  "processed": true,
  "processedDateTimeStamp": "2026-11-04T14:42:42.4044957+00:00",
  "isSaved": true
}