HomeGuidesAPI Reference
Log In

Dynamic Descriptor Guide

Dynamic Descriptor allows the merchant to define a dynamic descriptor, which appears in the payment statement. For dynamic descriptor, special configuration is required. For more information, please contact Revolv3 Support Team.
All the fields of the dynamic descriptor object are optional:

NameDescription
SubMerchantIdThe internal merchant’s ID, which is sent to the relevant card scheme
SubMerchantNamehe merchant name, as is displayed for the transaction on the consumer’s card statement.

For payment facilitator only, the maximum length of the parameter is 22, and might consist of the following structure: Prefix* where:

- Prefix – The PayFac prefix, approved by processor.
- * – A fixed character..
- – Sub-merchant name.

Recommended! An alternative method to define a prefix is by configuring it through the Revolv3 Portal. For more information, please contact Revolv3 Support Team.
SubMerchantPhoneThe merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement. It can also be an email address.
CountryCodeThe merchant (sub-merchant for payment facilitators) contact information, as is displayed for the transaction on the consumer’s card statement. It can also be an email address.
CityThe payment facilitator’s sub-merchant’s city name

:warning:Please be aware that to ensure successful payment processing through Nuvei, both Email and PhoneNumber parameters are required within the BillingAddress object.

Request example

{
    "FirstName": "Billie",
    "LastName": "Brown",
    "DynamicDescriptor":{
        "SubMerchantId": "98765",
        "SubMerchantName": "Test",
        "SubMerchantPhone": "408-555-1212",
        "CountryCode": "US",
        "City": "Oakland"
    },
    "PaymentMethod": {
        "BillingAddress": {
            "AddressLine1": "204 Bitterwater Rd",
            "City": "King City",
            "State": "CA",
            "PostalCode": "93930",
            "Country": "US",
            "PhoneNumber": "4803333333",
            "Email": "[email protected]"
        },
        "BillingFirstName": "Joe",
        "BillingLastName": "Doe",
        "CreditCard": {
            "PaymentAccountNumber": "476134******1390",
            "ExpirationDate": "0330",
            "SecurityCode": "737"
        }
    },
    "Invoice": {
        "InvoiceLineItems": [
            {
                "Name": "LineItem1",
                "Value": 10,
                "ValueType": "Standard"
            }
        ]
    }
}

Response example

{
    "customerId": 170081,
    "invoiceId": 464421,
    "merchantInvoiceRefId": null,
    "invoiceStatus": "Paid",
    "invoiceAttemptStatus": "Success",
    "message": "Approved",
    "subtotal": 10.0,
    "taxAmount": 0.0,
    "total": 10.0,
    "paymentMethodId": 155873
}