Skip to main content
POST
/
partner-connect
/
transactions
/
refund
Error
A valid request URL is required to generate request examples
{
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "refundTransactionId": "fb1022e5-50d8-4ff8-bfd9-7df68e4541c2",
  "status": "refunded",
  "amountRefunded": 100,
  "currency": "USD",
  "refundDate": "2025-03-19T09:46:54.363Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Requires the transactionId of the captured transaction, the amount to refund, currency, reason and a description in the request body.

​
transactionId
string<uuid>
required

Unique identifier of the card.

​
amount
number<float>
required

Requested transaction amount.

Required range: x >= 0.01Must be a multiple of 0.01
Example:

100

​
currency
string
required

Currency code (ISO 4217) of the transaction amount.

Required string length: 3
Example:

"USD"

​
description
string
required

Refund transaction description.

Example:

"Partial refund for item X"

​
reason
string
required

Reason for the refund.

Example:

"Customer requested"

Response

Refund processed successfully. Funds will be returned to the cardholder. The response includes a unique refundTransactionId.

​
transactionId
string<uuid>
required

The unique identifier (UUID) of the original captured transaction that was refunded.

​
refundTransactionId
string<uuid>
required

A unique identifier (UUID) specifically for this refund operation. Useful for tracking.

​
status
enum<string>
required

The status of the original transaction after the refund. It becomes refunded if fully refunded. If partially refunded, it might remain captured or move to a specific partial refund state (behavior depends on system logic - clarify if needed).

Available options:
locked,
captured,
void,
refunded
​
amountRefunded
number<float>
required

The actual amount refunded in this operation, formatted to 2 decimal places.

Required range: x >= 0.01Must be a multiple of 0.01
​
currency
string
required

Currency code (ISO 4217) of the refunded amount.

Required string length: 3
Example:

"USD"

​
refundDate
string<date-time>
required

The timestamp (ISO 8601 format) when the refund was successfully processed.

​
cardId
string<uuid>

The unique identifier (UUID) assigned to the successfully bound card. Store this cardId securely, as it is required to reference this card in all subsequent transaction requests (/verify, /purchase, etc.).

​
refId
string

A unique transaction identifier provided for the client’s reference. It can be used to track or correlate transactions

Example:

"CT6KQDDEC2"