Create a Void Request for a Previously Performed Sale or Auth Transaction.
POST/payment/{paymentId}/void
Creates a Void request for a previously performed Sale or Auth transaction.
Request
Path Parameters
- application/json
Body
required
Possible values: <= 255 characters
ID of the API request in the merchant system.
Processing entityId
provided by Nuvei.
Possible values: <= 45 characters
ID of the transaction in the merchant system.
Possible values: <= 50 characters
A free text field used to identify the product/service sold. If this parameter is left empty, need to insert a concatenation of all item names. It's not related to rebilling system product id. Risk rules and traffice management rules are usually built based on this field value.
Possible values: <= 255 characters
custom
object
subMerchant
object
Possible values: <= 15 characters
Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard
Possible values: <= 20 characters
The payment facilitator’s sub-merchant’s city name.
Possible values: >= 2 characters
and <= 2 characters
The payment facilitator’s sub-merchant’s 2-letter ISO country code
urlDetails
object
The URL to which notifications for outcome of the financial transactions is sent.
The URL to which the end user is redirected for a successful transaction with an APM.
The URL to which the end user is redirected for an unsuccessful transaction with an APM.
The URL to which the end user is redirected for a pending transaction with an APM.
Responses
- 200
- 400
- 401
- 403
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"refundId": "34564567",
"voidId": "34564567",
"transactionId": "string",
"externalTransactionId": "string",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
Bad request
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"refundId": "34564567",
"voidId": "34564567",
"transactionId": "string",
"externalTransactionId": "string",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"refundId": "34564567",
"voidId": "34564567",
"transactionId": "string",
"externalTransactionId": "string",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"refundId": "34564567",
"voidId": "34564567",
"transactionId": "string",
"externalTransactionId": "string",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
Possible values: <= 20 characters
Nuvei Digital Payments Gateway Transaction ID
Possible values: <= 50 characters
The transaction ID of the transaction in the event that an external service is used.
result
object
required
Possible values: [approved
, authorizedOnly
, declined
, error
, pending
, redirect
, challenge
, fingerprint
, authenticated
, authenticationNotSupported
]
errors
object
Possible values: <= 11 characters
Possible values: <= 400 characters
Possible values: <= 128 characters
The authorization code of the transaction.
providerResponseDetails
object
Possible values: <= 100 characters
Possible values: <= 400 characters
additionalTransactionInfo
object
{
"refundId": "34564567",
"voidId": "34564567",
"transactionId": "string",
"externalTransactionId": "string",
"result": {
"status": "approved",
"errors": {
"code": "7000.1000",
"reason": "Internal Processing Error"
}
},
"authCode": "string",
"providerResponseDetails": {
"code": "string",
"reason": "string"
},
"additionalTransactionInfo": {
"additionalTransactionBankId": "string",
"referenceId": "string"
}
}