Skip to main content

Create a payout

POST 
/payouts

Creates a Payout.

Request​

Header Parameters

    idempotency-key string

    Idempotency Key for the request

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

Body

    processingEntityId uuidrequired

    Processing entityId provided by Nuvei.

    merchantTransactionId string

    ID of the transaction in the merchant system.

    Possible values: <= 45 characters

    currencyConversion

    object

    type stringrequired

    Possible values: [MCP]

    originalAmount numberrequired

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

    originalCurrency stringrequired

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

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

    rateType string

    Possible values: [payment, payout, payoutMC]

    amount numberrequired

    The transaction amount.

    currency stringrequired

    Possible values: >= 3 characters and <= 3 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

    custom

    object

    property name* password

    deviceDetails

    object

    deviceName string
    deviceOS string
    deviceType string

    Supported device types include: DESKTOP, SMARTPHONE, TABLET, TV, UNKNOWN (if device type cannot be recognized).

    ipAddress string

    The customer's IP address.

    browser

    object

    acceptHeader string

    Exact content of the HTTP accept headers as sent to the 3DS Requestor from the cardholder's browser. If the total length of the accept header sent by the browser exceeds 2048 characters, the 3D-Secure Server truncates the excess portion.

    colorDepth integer

    Value representing the bit depth of the color palette for displaying images, in bits per pixel. Obtained from cardholder browser using the screen.colorDepth property. Values: 1, 4, 8, 15, 16, 24, 32, 48

    javaEnabled boolean

    Represents the ability of the cardholder browser to execute Java. REQUIRED when javaScriptEnabled is TRUE. Value is returned from the navigator.javaEnabled property. Values: TRUE, FALSE

    javaScriptEnabled boolean

    Determines whether the browser is JavaScript enabled (from navigator.javaScriptEnabled property). Values: TRUE, FALSE

    language string

    Value representing the browser language as defined in IETF BCP47. Returned from navigator.language property.

    screenHeight integer

    Total height of the cardholder's screen in pixels. Value is returned from the screen.height property.

    screenWidth integer

    Total width of the cardholder's screen in pixels. Value is returned from the screen.width property.

    timeZone string

    Time difference between UTC time and the cardholder browser local time, in minutes. Values: Value is returned from the getTimezoneOffset() method.

    userAgent string

    Exact content of the HTTP user-agent header. Values: If the total length of the user-agent header sent by the browser exceeds 2048 characters, the 3D-Secure Server truncates the excess portion.

    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.

    paymentOption

    object

    card

    object

    cardHolderName string

    The cardholder name.

    Possible values: <= 70 characters

    cardNumber passwordrequired

    The full card number.

    Possible values: non-empty and <= 20 characters

    expirationMonth stringrequired

    The card expiration month.

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

    Example: 12
    expirationYear stringrequired

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

    Example: 2023
    cvv password

    The CVV/CVC security code.

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

    Example: 123
    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    acquirer

    object

    The ID of the acquirer that processed the transaction.

    id string

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]{2,3}$

    Example: 99
    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    merchantId string
    merchantName string

    paymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    additionalData password
    Example: {"accountNumber":"11345739548759","routingNumber":"847937857"}

    temporaryPaymentToken

    object

    paymentTokenId tokenId (string)required

    Payment Token ID

    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2
    store storeUnreferencedRefund (string)

    Possible values: [none, tokenOnly, buyerToken]

    alternativePaymentMethod

    object

    name stringrequired

    Possible values: non-empty and <= 50 characters

    Example: ACH
    data password
    Example: {"accountNumber":"11345739548759","routingNumber":"847937857"}
    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    networkToken

    object

    provider TokenProvider (string)

    The name of the external token provider Possible values: [ApplePay, GooglePay]

    Possible values: [ApplePay, GooglePay]

    token string

    This encrypted token (REQUIRED for Apple Pay and Google Pay) represents a customer payment method generated by the external token provider

    Possible values: <= 5000 characters

    tokenAssuranceLevel string
    tokenRequestorId string
    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    acquirer

    object

    The ID of the acquirer that processed the transaction.

    id string

    Possible values: <= 3 characters, Value must match regular expression ^[0-9]{2,3}$

    Example: 99
    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    merchantId string
    merchantName string

    buyerDetails

    object

    buyerId string

    Possible values: <= 255 characters

    firstName string

    Possible values: <= 30 characters

    middleName string

    Possible values: <= 40 characters

    lastName string

    Possible values: <= 40 characters

    companyName string

    Possible values: <= 100 characters

    locale string

    Possible values: <= 5 characters

    dateOfBirth date
    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

    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

    2 digits ISO country code

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

    phone string

    Possible values: <= 18 characters

    addressMatch boolean

    shippingAddress

    object

    sameAsBilling boolean
    Default value: false
    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

    companyDetails

    object

    taxId string

    Possible values: <= 55 characters

Responses​

OK

Schema

    payoutId 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

    amount number

    The transaction amount.

    currency string

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

    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

    paymentOption

    object

    card

    object

    cardHolderName string

    The cardholder name.

    Possible values: <= 70 characters

    maskedCardNumber string

    The masked credit card number.

    Possible values: <= 20 characters

    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    Possible values: <= 8 characters

    last4Digits string

    The last four digits of the card number.

    Possible values: <= 4 characters

    expirationMonth string

    The card expiration month.

    Possible values: <= 2 characters

    expirationYear string

    The card expiration year.

    Possible values: <= 4 characters

    acquirerId string

    The ID of the acquirer that processed the transaction.

    Possible values: <= 2 characters

    cardType string

    The type of card used in the transaction. Values: Credit, Debit

    Possible values: <= 20 characters

    cardBrand string

    The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX

    Possible values: <= 20 characters

    paymentAccountReference string

    Possible values: <= 29 characters

    paymentTokenId tokenId (string)

    Payment Token ID

    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    alternativePaymentMethod

    object

    name stringrequired

    Possible values: non-empty and <= 50 characters

    Example: ACH
    data password
    Example: {"accountNumber":"11345739548759","routingNumber":"847937857"}
    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2
    paymentTokenId tokenId (string)

    Payment Token ID

    networkToken

    object

    provider TokenProvider (string)

    The name of the external token provider Possible values: [ApplePay, GooglePay]

    Possible values: [ApplePay, GooglePay]

    eciIndicator string

    Possible values: <= 100 characters

    expirationMonth string

    The card expiration month.

    Possible values: <= 2 characters

    expirationYear string

    The card expiration year.

    Possible values: <= 4 characters

    cardHolderName string

    The card holder name.

    Possible values: <= 70 characters

    maskedCardNumber string

    The masked credit card number.

    Possible values: <= 20 characters

    bin string

    The first six digits from the credit card number for identifying the processing bank. The rest of the number is not displayed.

    Possible values: <= 8 characters

    last4Digits string

    The last four digits of the card number.

    Possible values: <= 4 characters

    acquirerId string

    The ID of the acquirer that processed the transaction.

    Possible values: <= 2 characters

    cardType string

    The type of card used in the transaction. Values: Credit, Debit

    Possible values: <= 20 characters

    cardBrand string

    The card brand used in the transaction. Values: VISA, MASTERCARD, AMEX

    Possible values: <= 20 characters

    paymentTokenId tokenId (string)

    Payment Token ID

    merchantReference merchantReference (string)

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

    Possible values: <= 50 characters

    Example: 12391284AF87C7D2

    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
Loading...