Refund a transaction

POST

/{tenantCode}/v1/transaction/{id}/refund

This is the common endpoint to refund a transaction for both NG and Non-NG POS

Request

Path Params

Header Params

Body Params application/json

Example

{
    "amount": 0,
    "terminalId": "string",
    "deviceSpec": {
        "os": "string",
        "isBrowserBased": true
    },
    "overrides": {
        "useDeepLink": true,
        "vivaOptions": {
            "isvMerchantId": "string",
            "isvSourceCode": "string"
        },
        "verifoneVimOptions": {
            "confirmation": true,
            "pinCode": "string"
        }
    },
    "options": {
        "epassiOptions": {
            "accessKey": "string"
        }
    },
    "orderItems": [
        {
            "description": "string",
            "referenceId": "string",
            "quantity": 0,
            "quantityUnit": "string",
            "amount": 0,
            "vatAmount": 0,
            "vatRate": 0,
            "type": 1
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sandbox.api.confirmapay.com//v1/transaction//refund' \
--header 'Device-Id;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 0,
    "terminalId": "string",
    "deviceSpec": {
        "os": "string",
        "isBrowserBased": true
    },
    "overrides": {
        "useDeepLink": true,
        "vivaOptions": {
            "isvMerchantId": "string",
            "isvSourceCode": "string"
        },
        "verifoneVimOptions": {
            "confirmation": true,
            "pinCode": "string"
        }
    },
    "options": {
        "epassiOptions": {
            "accessKey": "string"
        }
    },
    "orderItems": [
        {
            "description": "string",
            "referenceId": "string",
            "quantity": 0,
            "quantityUnit": "string",
            "amount": 0,
            "vatAmount": 0,
            "vatRate": 0,
            "type": 1
        }
    ]
}'

Responses

🟢200Success

application/json

Refund initiated

Body

Example

{
    "data": {
        "orderId": "string",
        "transactionId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "status": 1,
        "subStatus": 1000,
        "deepLinkUrl": "string",
        "customerRedirectUrl": "string",
        "merchantRedirectUrl": "string",
        "paymentChannelMetaData": {
            "verifoneVim": {
                "transactionType": 1,
                "verifoneVimTerminalTransactionId": "string"
            }
        }
    },
    "description": {
        "code": "string",
        "message": "string"
    },
    "narrative": {
        "code": "string",
        "message": "string"
    }
}

🟢200Success

Modified at 2025-12-08 17:03:46

Cancel a transaction

Generic Refund (Without existing Transaction Id)