Skip to main content

Create a Refund Unrelated to a Previous Transaction.

POST 
/refund

Creates a refund unrelated to a previous transaction.

Request​

Body

    idempotencyId string

    Possible values: <= 255 characters

    ID of the API request in the merchant system.

    processingEntityId uuidrequired

    Processing entityId provided by Nuvei.

    merchantTransactionId string

    Possible values: <= 45 characters

    ID of the transaction in the merchant system.

    currencyConversion

    object

    type stringrequired

    Possible values: [MCP]

    originalAmount numberrequired

    The original amount of the transaction in the currency that the merchant requested.

    originalCurrency stringrequired

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

    The 3-letter ISO currency code of the currency that the merchant requested in the transaction.

    amount numberrequired

    The transaction amount.

    currency stringrequired

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

    productId string

    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.

    custom

    object

    property name* password

    subMerchant

    object

    id string

    Possible values: <= 15 characters

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

    city string

    Possible values: <= 20 characters

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

    countryCode string

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

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

    urlDetails

    object

    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.

    paymentOption

    object

    required

    card

    object

    cardHolderName string

    Possible values: <= 70 characters

    The card holder name.

    cardNumber passwordrequired

    Possible values: non-empty and <= 20 characters

    The full card number.

    expirationMonth stringrequired

    Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^(0[1-9]|1[0-2])$

    The card expiration month.

    expirationYear stringrequired

    Possible values: >= 2 characters and <= 4 characters, Value must match regular expression ^(\d{4}|\d{2})$

    cvv password

    Possible values: >= 3 characters and <= 4 characters, Value must match regular expression ^([0-9]{3}|[0-9]{4})$

    The CVV/CVC security code.

    merchantReference merchantReference (string)

    Possible values: <= 50 characters

    Merchant Reference for a business entity (token, subscription, etc.)

    paymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    additionalData

    object

    property name* password

    temporaryPaymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    merchantReference merchantReference (string)

    Possible values: <= 50 characters

    Merchant Reference for a business entity (token, subscription, etc.)

    store storeUnreferencedRefund (string)

    Possible values: [none, tokenOnly, buyerToken]

    buyerDetails

    object

    buyerId string

    Possible values: <= 255 characters

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    companyName string

    Possible values: <= 100 characters

    locale string

    Possible values: <= 5 characters

    The user's locale and default language.

    dateOfBirth date

    Format is YYYY-MM-DD.

    email string

    Possible values: <= 100 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

    workPhone string

    Possible values: <= 18 characters

    nationalIdentificationNumber password

    Possible values: <= 25 characters

    The user's national ID number.

    billingAddress

    object

    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode stringrequired

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

    phone string

    Possible values: <= 18 characters

    addressMatch boolean

    Set to “true” when address matches shipping address.

    shippingAddress

    object

    sameAsBilling boolean
    address string

    Possible values: <= 60 characters

    addressLine2 string

    Possible values: <= 60 characters

    addressLine3 string

    Possible values: <= 60 characters

    state string

    Possible values: <= 6 characters

    zip string

    Possible values: <= 10 characters

    city string

    Possible values: <= 30 characters

    countryCode string

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

    firstName string

    Possible values: <= 30 characters

    lastName string

    Possible values: <= 40 characters

    phone string

    Possible values: <= 18 characters

    phone2 string

    Possible values: <= 18 characters

Responses​

OK

Schema

    refundId idType (string)
    transactionId transactionId (string)

    Possible values: <= 20 characters

    Nuvei Digital Payments Gateway Transaction ID

    externalTransactionId ExternalTransactionId (string)

    Possible values: <= 50 characters

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

    amount number

    The transaction amount.

    currency string

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

    authCode string

    Possible values: <= 128 characters

    The authorization code of the transaction.

    providerResponseDetails

    object

    code string

    Possible values: <= 100 characters

    reason string

    Possible values: <= 400 characters

    additionalTransactionInfo

    object

    additionalTransactionBankId string
    referenceId string

    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

    reason string

    Possible values: <= 400 characters

Loading...