Skip to main content

Void a (Void of Settle)

POST 
/payments/{payment-id}/settles/{settle-id}/voids/{void-id}/voids

Voids a previous Void request of a settle.

Request​

Path Parameters

    payment-id stringrequired

    Payment ID generated by REST API

    Example: 49900038994789921
    settle-id stringrequired

    Settle ID generated by REST API

    Example: 49900038994789921
    void-id stringrequired

    Void ID generated by REST API

    Example: 49900038994789921

Header Parameters

    idempotency-key string

    Idempotency Key for the request

    Example: 31f9952c-0058-458b-8244-4ae110ef1556

Body

required

    processingEntityId uuidrequired

    Processing entityId provided by Nuvei.

    merchantTransactionId string

    ID of the transaction in the merchant system.

    Possible values: <= 45 characters

    productId string

    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 traffic management rules are usually built based on this field value.

    Possible values: <= 50 characters

    siteNameOverride string

    Possible values: <= 255 characters

    custom

    object

    property name* password

    subMerchant

    object

    id string

    Represents the internal merchant’s ID, which is forwarded to Visa and Mastercard

    Possible values: <= 15 characters

    city string

    The payment facilitator’s sub-merchant’s city name.

    Possible values: <= 20 characters

    countryCode string

    The payment facilitator’s sub-merchant’s 2-letter ISO country code.

    Possible values: >= 2 characters and <= 2 characters

    urlDetails

    object

    With this class, a merchant can dynamically provide possible URLs to which the end user is redirected after a payment is made, as well as a dynamic URL for DMNs.

    webhookUrl string

    The URL to which notifications for outcome of the financial transactions is sent.

    successUrl string

    The URL to which the end user is redirected for a successful transaction with an APM.

    failureUrl string

    The URL to which the end user is redirected for an unsuccessful transaction with an APM.

    pendingUrl string

    The URL to which the end user is redirected for a pending transaction with an APM.

Responses​

OK

Schema

    voidId idType (string)
    Example: 2f00eba7-66ad-4d8b-8d54-b8c9183e664f
    transactionId transactionId (string)

    Nuvei Digital Payments Gateway Transaction ID

    Possible values: <= 20 characters

    externalTransactionId ExternalTransactionId (string)

    The transaction ID of the transaction in the event that an external service is used.

    Possible values: <= 50 characters

    result

    object

    required

    status stringrequired

    Possible values: [approved, authorizedOnly, declined, error, pending, redirect, challenge, fingerprint, authenticated, authenticationNotSupported]

    errors

    object

    code string

    Possible values: <= 11 characters

    Example: 7000.1000
    reason string

    Possible values: <= 400 characters

    Example: Internal Processing Error
    authCode string

    The authorization code of the transaction.

    Possible values: <= 128 characters

    providerResponseDetails

    object

    code string

    Possible values: <= 100 characters

    reason string

    Possible values: <= 400 characters

    additionalTransactionInfo

    object

    additionalTransactionBankId string
    referenceId string
Loading...