transaction

Process a refund

Changed on
post/transaction/{apiKey}/refund

Request

Path parameters

apiKeystring required

API Key of Connector

Request body

merchantTransactionIdstring required
additionalId1string
additionalId2string
referenceSchemeLifecycleIdentifierstring
extraDataExtraData
pspPassthroughDataPspPassthroughData
merchantMetaDatastring
referenceUuidstring required
amountstring required
currencystring required
callbackUrlstring
transactionTokenstring
descriptionstring

Response

Transaction response

successboolean
uuidstring
purchaseIdstring
returnType'FINISHED' | 'REDIRECT' | 'HTML' | 'PENDING' | 'ERROR' | 'PENDING_DCC'
redirectType'iframe' | 'fullpage' | '3ds'
redirectUrlstring
redirectQRCodestring

DataUrl

htmlContentstring
paymentDescriptorstring
paymentMethodstring
adapterMerchantTransactionIdstring

Adapter/PSP-side merchant transaction identifier recorded for transaction matching and reconciliation. Omitted when unavailable.

amountstring
surchargeAmountstring
gstAmountstring
totalAmountstring
adapterMessagestring
adapterCodestring
extraDataExtraData

Example response

{
  "returnData": {
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  }
}

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the request property's maxLength was increased from 255 to 4096

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status