Reporting

  1. Nuvei generates a daily transactional report file for the Marketplace. The transactional report file contains the following information:

    ID
    ID
    Definition
    The ID of the transaction in Smart2Pay system
    Type
    int
    : The ID of the transaction in Nuvei system;

    MerchantTransactionID
    MerchantTransactionID
    Definition
    Merchant Transaction ID, a number that uniquely identifies a transaction in your system.
    Type
    string
    : Merchant Transaction ID, a number that uniquely identifies a transaction in your system;

    OriginatorTransactionID
    OriginatorTransactionID
    Definition
    The ID of the transaction/refund in The Marketplace system
    Type
    string
    : The ID of the transaction/refund in The Marketplace system;

    InputDateTime
    InputDateTime
    Definition
    The date and time of inserting the transaction in Smart2Pay system
    Type
    datetime
    : The date and time of inserting the transaction in Nuvei system;

    PaymentStateDefID
    PaymentStateDefID
    Definition
    The ID of the payment status in Smart2Pay system. It can have the following values: 1 - Open, 2 - Success, 3 - Cancelled, 4 - Failed, 5 - Expired, 9 - Authorized, 11 - Captured.
    : The status id of the transaction in Nuvei system;

    Status
    Status
    Definition
    The description of the transaction status in the Smart2Pay system: Open (Pending), Success (not used for card payments), Cancelled, Failed, Expired, Authorized, Captured.
    : The description of the transaction status in the Nuvei system;

    MerchantAmount
    MerchantAmount
    Definition
    The amount of the transaction.
    Type
    float
    : The amount of the transaction;

    MerchantCurrency
    MerchantCurrency
    Definition
    The currency of the transaction. ISO 4217 format (e.g. EUR)
    : The currency of the transaction;

    CapturedAmount
    CapturedAmount
    Definition
    The amount that has been captured. Float with 2 decimals (e.g. 33.99)
    Type
    float
    : The amount that has been captured;

    MethodID
    MethodID
    Definition
    The ID of the payment methods used. For credit cards payments the ID is 6.
    Type
    int
    : The ID of the payment methods used. For credit cards payments this is 6.;

    MethodName
    MethodName
    Definition
    The name of the payment method used: SmartCards.
    : The name of the payment method used.;

    ReportedByBOTOperatorDate
    ReportedByBOTOperatorDate
    Definition
    The date when the transaction was exported to CSV file.
    Type
    datetime
    : The date when the transaction was exported to csv file;

    SpecificDetails
    SpecificDetails
    Definition
    Specific Details
    : Not used;

    ReconciliationProviderID
    ReconciliationProviderID
    Definition
    The ID that appears on the bank statement of the customer (usually same as RootProviderTransactionID).
    Type
    string
    : ID appearing on the bank statement of the customer (usually same as RootProviderTransactionID);

    ProviderTransactionID
    ProviderTransactionID
    Definition
    Provider Transaction ID
    : Not used for card payments;

    MerchantAlias
    MerchantAlias
    Definition
    The name of the Shop.
    Type
    string
    : Shop Name;

    RootProviderTransactionID
    RootProviderTransactionID
    Definition
    The ID of the payment in acquiring system.
    Type
    string
    : ID of the payment in acquiring system;

    Country
    Country
    Definition
    The country of the payer if available. ISO_3166-1_alpha-2 format. (e.g. IT).
    : The country of the payer if available.

    2.  

  2. Nuvei will generate a Settlement invoice report containing information at transaction level for each shop. The Settlement invoice report contains the following information:

    1 Settlement invoice report per shop

    GPaymentId
    GPaymentId
    Definition
    GPaymentId
    : Not used;

    PaymentId
    PaymentId
    Definition
    The ID of the payment in Smart2Pay system.
    Type
    int
    : PaymentID in Nuvei system;

    Type
    Type
    Definition
    Transaction Type. It can be type: Payment, Refund, Inquiry or Chargeback.
    Type
    string
    : Transaction Type. Can be Payment, Refund, Inquiry or Chargeback;

    PaymentMethodName
    PaymentMethodName
    Definition
    The name of the payment method used. E.g. SmartCards
    Type
    string
    : Name of the payment method used;

    CustomerName
    CustomerName
    Definition
    The name of the customer, if available.
    Type
    string
    : The name of the customer, if available;

    MerchantName
    MerchantName
    Definition
    The name of the merchant account.
    Type
    string
    : The name of the merchant account;

    MerchantID
    MerchantID
    Definition
    The ID of the transaction/refund in your system.
    Type
    string
    : The transaction/refund id in your system;

    GtId
    GtId
    Definition
    GtId
    : Not used;

    IssuerName
    IssuerName
    Definition
    Issuer Name
    : Not used;

    IdealTrxId
    IdealTrxId
    Definition
    IdealTrxId
    : Not used;

    Country
    Country
    Definition
    The country of the payer, if available. ISO_3166-1_alpha-2 format. (e.g. IT).
    : The country of the payer, if available;

    InputDateTime
    InputDateTime
    Definition
    The date and time of inserting the transaction in Smart2Pay system.
    Type
    datetime
    : The date and time of inserting the transaction in Nuvei system;

    Amount
    Amount
    Definition
    The amount of the transaction.
    Type
    float
    : The amount of the transaction;

    Currency
    Currency
    Definition
    The currency of the transaction. ISO 4217 format (e.g. EUR).
    : The currency of the transaction;

    Status
    Status
    Definition
    The description of the transaction status in the Smart2Pay system: Open (Pending), Success (not used for card payments), Cancelled, Failed, Authorized, Captured
    : The description of the transaction status in the Nuvei system;

    ExchangeRate
    ExchangeRate
    Definition
    The exchange rate if the transaction needs to be converted from transaction currency to the settlement currency.
    Type
    float
    : The exchange rate if the transaction needs to be converted from transaction currency to the settlement currency;

    CalculatedAmount
    CalculatedAmount
    Definition
    The transaction amount converted to the settlement currency.
    Type
    float
    : The transaction amount converted to the settlement currency;

    ReferenceCurrency
    ReferenceCurrency
    Definition
    The settlement currency.
    Type
    float
    : The settlement currency;

    TransactionFee
    TransactionFee
    Definition
    Gateway fee (if applies).
    Type
    float
    : Gateway fee (if applies);

    GeneralFee
    GeneralFee
    Definition
    Gateway fee (if applies)
    Type
    float
    : Gateway fee (if applies);

    AttemptFee
    AttemptFee
    Definition
    Gateway fee (per attempt, if applies).
    Type
    float
    : Gateway fee (per attempt, if applies);

    IssuedFee
    IssuedFee
    Definition
    Gateway fee (per acquiring bank/payment method provider attempt fee if applies).
    Type
    float
    : Gateway fee (per acquiring bank/payment method provider attempt fee if applies);

    LocalVatFee
    LocalVatFee
    Definition
    Local payment method VAT (if applies).
    Type
    float
    : Local payment method VAT (if applies);

    VAT
    VAT
    Definition
    Value added tax (if applies).
    Type
    float
    : Value added tax (if applies);

    Comission
    Comission
    Definition
    Commission of the marketplace/agent (if applies).
    Type
    float
    : Commission of the marketplace/agent (if applies);

    SiteID
    SiteID
    Definition
    The ID of the shop.
    Type
    int
    : ID of the shop;

    SiteAlias
    SiteAlias
    Definition
    Shop Alias.
    Type
    string
    : Shop Alias;

    OriginatorTransactionID
    OriginatorTransactionID
    Definition
    The ID of the transaction/refund in The Marketplace system.
    Type
    string
    : The ID of the transaction/refund in The Marketplace system.

    3.  

  3. Nuvei will also generate an aggregated Settlement invoice report containing information at transaction level for the Marketplace. Settlement of the commission will be based on this settlement invoice. Format is the same as in the Settlement invoice report above.

Below there are examples of Settlement invoice reports in all supported formats:

Marketplace Operator Invoice

The total payout amount to the marketplace operator is computed using the below algorithm.

Algorithm: TPM (total payout marketplace) = CO – D2

Where:
  • CO (commission amount) = B + C – A2 – A3
  • OR (Operator Remitted fees) = E – A4
  • B, C, A2, A3 – as defined in Shop Settlement Invoices section
  • D2 (Acquiring Fees) = TBD_FIXED_FEE + TBD_%_FEE * CO

Shop Settlement Invoices

The total payout amount to be paid to the shop is computed using the below algorithm.

Algorithm: TPS (total payout shop) = TA – D2

Where:
  • TA (transfer_amount) = A – B – R – C – D1
  • A (order/taxes/fees) = A1 + A2 + A3
  • A1 = ORDER_AMOUNT + ORDER_SHIPPING_AMOUNT + ORDER_AMOUNT_TAX + ORDER_SHIPPING_AMOUNT_TAX
  • A2 = REFUND_COMMISSION_FEE (return the commission back to shop in case of a refund) + REFUND_COMMISSION_VAT
  • A3 = MANUAL_CREDIT + MANUAL_CREDIT_VAT
  • A4 = OPERATOR_REMITTED_REFUND_ORDER_AMOUNT_TAX + OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX
  • B (operator commission) = COMMISION_FEE + COMMISION_VAT
  • R(refunds) = REFUND_ORDER_AMOUNT + REFUND_ORDER_SHIPPING_AMOUNT + REFUND_ORDER_AMOUNT_TAX + REFUND_ORDER_SHIPPING_AMOUNT_TAX
  • C (non transactional fees) = SUBSCRIPTION_FEE + SUBSCRIPTION_VAT + MANUAL_INVOICE + MANUAL_INVOICE_VAT
  • D1 (Acquiring Fees) = FIXED_FEE + %_FEE * A1
  • D2 (Settlement Fees) = FIXED_FEE + %_FEE * TA
  • E (Operator Remitted fees) = OPERATOR_REMITTED_ORDER_AMOUNT_TAX + OPERATOR_REMITTED_REFUND_ORDER_SHIPPING_AMOUNT_TAX

Pre-Settlement Transaction API

Information about all the transactions created or updated within a certain interval can be retrieved by using an action based on GET HTTP request. The response will contain a transaction list in JSON format that returns all the transactions that were created or updated in the interval start_date – end_date.

Only a limited amount of details for each transaction will be provided.

Definition: GET /v1/transactions?{start_date}&{end_date}

Where:
  • {start_date} – format: {Year(4)}-{month(2)}-{day(2)}T{Hour(2)}:{Minute(2)}:{Second(2)}Z)
  • {end_date} – format: {Year(4)}-{month(2)}-{day(2)}T{Hour(2)}:{Minute(2)}:{Second(2)}Z)

Request Model:

GET /v1/transactions?{start_date}&{end_date}
Authorization: Basic Pre-shared-APIKEY

Response Model:

{
    "transactions": [
        {
            "amount": 0.80,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1234,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "COMMISSION_VAT"
        },
        {
            "amount": 3.33,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1235,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "COMMISSION_FEE"
        },
        {
            "amount": 0,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1236,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "ORDER_SHIPPING_AMOUNT"
        },
        {
            "amount": 10.00,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1237,
            "order_id": "34991440-A",
            "order_line_id": "34991440-A-1",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "ORDER_AMOUNT"
        },
        {
            "amount": 1.60,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1238,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "COMMISSION_VAT"
        },
        {
            "amount": 6.66,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1239,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "COMMISSION_FEE"
        },
        {
            "amount": 0,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1240,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "ORDER_SHIPPING_AMOUNT"
        },
        {
            "amount": 10.00,
            "currency": "EUR",
            "date_created": "2018-09-17T12:55:08Z",
            "last_updated": "2018-10-12T00:00:30Z",
            "cart_id": 1241,
            "order_id": "34991440-A",
            "order_line_id" : "34991440-A-2",
            "payment_state": "PAID",
            "payment_batch_number": "000068",
            "refund_id": null,
            "seller_id": 6221,
            "seller_name": "Best Shop",
            "transaction_type": "ORDER_AMOUNT"
        }
    ],
    "total_count": 8
}

The transaction_type field contains the following information:

  • COMMISSION_VAT
  • COMMISSION_FEE
  • ORDER_SHIPPING_AMOUNT
  • ORDER_AMOUNT
  • MANUAL_CREDIT
  • MANUAL_CREDIT_VAT
  • ORDER_AMOUNT_TAX
  • ORDER_SHIPPING_AMOUNT_TAX
  • REFUND_ORDER_AMOUNT
  • REFUND_ORDER_SHIPPING_AMOUNT
  • REFUND_COMMISSION_FEE
  • REFUND_COMMISSION_VAT
  • REFUND_ORDER_AMOUNT_TAX
  • REFUND_ORDER_SHIPPING_AMOUNT_TAX
  • SUBSCRIPTION_FEE
  • SUBSCRIPTION_VAT
  • CHARGE_ALL_FEES_INSTRUCTIONS

Only the transactions with payment_state = “PAID” will be settled in the current settlement cycle.

Settlement Flow

Settlement cycles are defined in Nuvei system. Based on this, Nuvei generates settlement invoices for each shop. Also, Nuvei generates a commission settlement invoice for The Marketplace.

The acquiring banks and alternative payment method providers settle to Nuvei the (Gross amount – Acquiring/Processing Fees).

  • Nuvei settles gross amount – operator commission – acquiring fees to each shop. Settlement frequency: weekly.
  • Nuvei settles commission to The Marketplace based on Transaction Log API exposed by the Marketplace. Settlement frequency: weekly.

Optional functionalities:

  • Subscription fee can be collected by Nuvei from the shops on behalf of the marketplace operator.
  • Manual credits / debits will be issued by The Marketplace towards the shops and performed by Smart2Pay.
  • The Marketplace can withhold the payment of certain transactions towards the shop (e.g. only the transactions with PaymentStatus marked as PAID will be settled).

Reconciliation

Nuvei reconciles at transaction level with the acquiring banks and alternative method providers.

The SiteID / APIKEY will be used to initiate the transactions towards Smart2Pay. The Marketplace Transaction ID needs to be submitted by Nuvei REST API in the OriginatorTransactionID field for reporting and reconciliation purposes towards the shops / Marketplace.

Transactional Flow

Orders containing items from multiple shops will be sent for authorization in multiple transactions, each transaction containing items for a single shop.

Credit card transactions are authorized and their status is communicated on the following route: Acquirer -> Nuvei -> Marketplace.

Transactions are manually captured within 7 days from authorization.

Tokenization, 3D and fraud prevention solutions are available upon request. For more information visit: Credit Card Payments.

Alternative payment methods are authorized and captured in one step and their status is communicated on the following route: Payment method provider -> Nuvei -> Marketplace.

You need to integrate our REST API described here: https://docs-apm.nuvei.com.

Shop Approval Notification

Whenever a shop is approved in Nuvei onboarding system, a notification is sent from Nuvei to the Marketplace to a page where the following info is send, and whether it was successful or not.

The Marketplace needs to respond with HTTP return code 204 (No Content) otherwise the approval will be resubmitted!

Definition: POST /api/shop/{ID}/notification

Where:
  • {ID} – ID of the shop

Shop Approval Notification Format:

{
    "merchant_site": {
        "shop_id": Int,
        "site_id": Int (eg. 31261),
        "api_key": "SmasdsPx6n2KJU9MNKcBdlqdLJZOXSl9IA/kdksjSsdDWD",
        "created": "Date (yyyy-mm-dd hh:mm:ss, eg. 2018-12-31 23:59:59)",
        "url": "http://www.johnshop.it",
    }
}

Response:

204 No Content

We recommend you to always verify the Notification content we sent and not just simply/automatically respond to our notifications.

In exceptional cases it is possible to receive duplicate notifications and your system should be able to handle such situations.

If you do not respond to the notifications of type Approval or our system will keep sending the notifications until it receives a response. At first you will be notified more often. Once the time passes the notifications from our system will be rare and they will eventually stop (after a period of time defined in our system, currently set to 7 days).

Get a List of Documents

Information about the required documents can be retrieved by using an action based on GET HTTP request. The response will contain a list of documents provided for each Shop ID in JSON format.

The resource exposed for GET requests at the download_link location will be the actual file in binary format.

Definition: GET /api/shops/{shop_id}/documents

Where:
  • {shop_id} – The ID of the shop, a unique number that identifies the shop in the GlobalPay system.

Request Model:

GET /api/shops/{shop_id}/documents
Authorization: Basic Pre-shared-APIKEY

Response Model:

{
    "shop_documents": [
        {
            "id": Int (Document id),
            "shop_id": Int,
            "date_uploaded": "Date (yyyy-mm-dd hh:mm:ss, eg. 2018-12-31 23:59:59)",
            "file_name": "String (Original file name if available)",
            "file_type": "doc" | "docx" | "pdf" | "jpg" | "jpeg" | "gif" | "png" | "bmp" | "tiff" | "tif",
            "file_size": Int (size in bytes expected to be downloaded),
            "type": "company_certificate" | "register_of_directors" | "bank_statement" | "passport" | "bill" | "other",
            "contact_email": "Email of contact for which this document was uploaded - applies ONLY for passport or bill (should match contact email)",
            "download_link": "Link to download the file (if available), if file is not exposed through web server, provide entry point where we can download the file"
        },
        ...
    ],
    "total_count": Int
}

The following documents are required by Nuvei KYC platform:

  1. Bank statement (Not older than 6 months, with account holder and IBAN code visible);
  2. Company certificate / Incorporation certificate (Not older than 6 months);
  3. Register of directors (or any other document showing the company’s legal representatives) (Not older than 6 months);
  4. Passport copy of company’s legal representatives: (Legible ID copy in color within validity period);
  5. Utility bill that can be used as proof of address for company’s legal representatives (Not older than 6 months).

Get a List of Shops

In order to import a list of newly created shops you will need to expose an API which Nuvei can call using an action based on GET HTTP request. The response will contain a shop list in JSON format that returns all the shops that were created or updated after last_updated_date.

Only a limited amount of details for each shop will be provided.

Definition: GET /api/shops?last_updated_date={last_updated_date}

Where:
  • {last_updated_date} – format: {Year(4)}-{month(2)}-{day(2)}T{Hour(2)}:{Minute(2)}:{Second(2)}Z)
    eg. 2021-01-01T20:11:01Z

Request Model:

GET /api/shops?last_updated_date=2021-01-01T20:11:01Z
Authorization: Basic Pre-shared-APIKEY
Where:
  • Pre-shared-APIKEY – consists of the user name and password previously requested in the Shop Integration step

Response Model:

{
"shops": [
  {
    "shop_id": Int,
    "shop_name": String,
    "shop_state": "OPEN" | "CLOSED" | "SUSPENDED",
    "company_legal_name" : String,
    "company_number": String,
    "vat": String,
    "country": "String (ISO 3166-1 alpha-2-chars)",
    "company_type": String ("S.A.S." | "S.S." | "S.N.C." | "S.P.A." | "S.A.P.A" | "S.R.L" | "LLC" | "LLP" | "Corporation" | "Non-Profit" | "Parnership" | "Other")
    "company_type_text": String (In case company_type="Other")
    "business_sector": String ("Advisory services" | "Digital games" | "Education" | "Entertainment" | "Finance" | "Forex" | "Gambling" | "Mass media" | "Money transfer" | "Retail - fashion" | "Retail - other" | "Social networks" | "Software" | "Telecommunication" | "Transportation" | "Travel")
    "business_model": "String (information about products or services)",
    "main_activity": "String (what is merchant selling - will appear in agreement)",
    "date_of_establishment": "Date (yyyy-mm-dd hh:mm:ss, eg. 2018-12-31 23:59:59)",
    "company_website": String,
    "mcc": Int (https://en.wikipedia.org/wiki/Merchant_category_code),
    "ecommerce_sites": [ "http://www.site1.com", "http://www.site2.com", "http://www.site3.com" ] (max 3),
    "top_3_markets": [ "String (ISO 3166-1 alpha-2)", "String (ISO 3166-1 alpha-2)", "String (ISO 3166-1 alpha-2)" ] (max 3),
    "annual_volume": Int (in EUR),
    "atv": Int (Average transaction value in EUR),
    "headquarters_address": {
        "street": String,
        "zip_code": String,
        "city": String,
        "state": String,
        "phone": String,
        "fax": String,
        "country": "String (ISO 3166-1 alpha-2-chars)"
    },
    "banking_details": {
        "bank_name": String,
        "account_holder": String,
        "account_currency": "String (ISO 3 chars currency)",
        "iban": String,
        "account_number": String,
        "swift": String
    },
    "contact_informations": { (MANDATORY)
        "title": String ("Mr."|"Ms."|"Mrs."),        
        "firstname": String,
        "lastname": String,
        "email": "String MANDATORY",
        "country": "String (ISO 3166-1 alpha-2-chars)"
    },
    "ubos": [
        {
            "percentage": Int,
            "title": String ("Mr."|"Ms."|"Mrs."),
            "firstname": String,
            "lastname": String,
            "street": String,
            "zip_code": String
            "city": String,
            "state": String,
            "country": "String (ISO 3166-1 alpha-2-chars)",
        },
        ...
    ],
   "representatives": [
        {
            "signing_right": Boolean,
            "title": String ("Mr."|"Ms."|"Mrs."),
            "firstname": String,
            "lastname": String,
            "email": "String MANDATORY",
            "date_of_birth": "Date (yyyy-mm-dd hh:mm:ss, eg. 2001-12-31 23:59:59)",
            "street": String,
            "zip_code": String
            "city": String,
            "state": String,
            "country": "String (ISO 3166-1 alpha-2-chars)",
        },
        ...
    ],
    "date_created": "Date (yyyy-mm-dd hh:mm:ss, eg. 2021-01-20 23:59:59)",
    "last_updated_date": "Date (yyyy-mm-dd hh:mm:ss, eg. 2021-01-20 23:59:59)",
    "logo": String,
    "commision_trx_percentage": Float,
    "commision_trx_fixed_amount": Float,
    "commision_trx_currency": "String (ISO 3 chars currency)",
    }
],
"total_count": Int (number of shops in the list)
}

Not all fields are mandatory in the above request! If the Marketplace does not provide all the necessary data, the shop representative will fill the missing fields in Nuvei platform. Once Nuvei identifies a newly created shop, it creates an account in Nuvei KYC platform for the shop representative and sends an email asking to finalize the application (e.g. fill missing info, upload documents, sign the online contract).

Marketplace API

Marketplace API is the seamless solution that provides access to credit card payments and alternative payment methods for a Marketplace in a simple yet reliable legal and technical setup. Its aim is to provide a robust technical solution which will ensure that all of the participating shops as well as the marketplace will benefit of a seamlessly onboarding process, reliable and secure transaction processing, reconciliation to the penny and prompt settlements.

1 Marketplace - Processes and Systems

The technical process (KYC Flow) with all the necessary steps is described next:

  • The Marketplace accepts a new shop on its platform and creates an entry in the database.
  • The Marketplace exposes an API which Nuvei KYC platform calls several times per day to pull information about the newly created shops.
  • Nuvei KYC platform pulls all available information about the shop (ShopID, Alias, shop representative e-mail, documents etc.). If all the required information is not available, the merchant representative will have to fill it in on Nuvei KYC platform.
  • Nuvei will create an account for the shop in the Nuvei KYC platform and send an e-mail to the shop representative with the login details.
  • The shop representative will fill in any missing company related data and upload KYC/UBO specific documentation.
  • The shop representative signs online the Merchant agreement for Payment processing.
  • Nuvei Risk team reviews the company.
  • In case of approval, a siteID is generated in the Nuvei platform.
  • Nuvei will do a push notification to a page designated by The Marketplace with the following info ShopID, SiteID, APIKEY. The last two parameters need to be used when calling Nuvei REST API when processing the payments. The Marketplace needs to respond with HTTP return code 204 (No content) to the POST notification.