Refund full amount/partial linked to previous transactions.

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"
        },
        "worldLineOptions": {
            "cashierIdentification": "string"
        },
        "nexiOptions": {
            "customerPresentForRefund": true,
            "cashBackAmount": 0
        },
        "retain24Options": {
            "accountId": "string"
        },
        "netsBaxiOptions": {
            "operatorId": "string"
        },
        "softPayOptions": {
            "employeeReference": "string",
            "merchantReference": "string",
            "tipping": {
                "enableTipping": true,
                "percentageOptions": [
                    0
                ]
            }
        }
    },
    "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 'https://sandbox.api.confirmapay.com//v1/transaction//refund' \
--header 'Device-Id;' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data '{
    "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"
        },
        "worldLineOptions": {
            "cashierIdentification": "string"
        },
        "nexiOptions": {
            "customerPresentForRefund": true,
            "cashBackAmount": 0
        },
        "retain24Options": {
            "accountId": "string"
        },
        "netsBaxiOptions": {
            "operatorId": "string"
        },
        "softPayOptions": {
            "employeeReference": "string",
            "merchantReference": "string",
            "tipping": {
                "enableTipping": true,
                "percentageOptions": [
                    0
                ]
            }
        }
    },
    "orderItems": [
        {
            "description": "string",
            "referenceId": "string",
            "quantity": 0,
            "quantityUnit": "string",
            "amount": 0,
            "vatAmount": 0,
            "vatRate": 0,
            "type": 1
        }
    ]
}'

Responses

🟢201 - Refund initiatedCreated

application/json

Refund initiated

Bodyapplication/json

Example

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

🟠400 - Refund amount is higher than original amountBad Request

🟠400 - This transaction was not originated from this deviceBad Request

Modified at 2026-10-29 04:45:28

Get payment method content

AdditionalPaymentMethods