Parameter reference

This is the exhaustive reference for all API parameters.

reminder

The below definitions can vary depending on context (payment method, integration mode, MCC …)

Processing input/output parameters

  • 3DSECURE boolean

    Ask for a 3-D Secure authentication.

  • 3DSECURE_CAVV hexadecimal string (40 max)

    3-D Secure “Cardholder Authentication Verification Value”.

  • 3DSECURE_CARDENROLLED u, n, y

    Card’s enrollment status.

  • 3DSECURE_CAVVALGORITHM int (1)

    3-D Secure “Cardholder Authentication Verification Value” algorithm(0-9).

  • 3DSECURE_ECI string (1)

    Electronic Commerce Indicator.

  • 3DSECURE_RESULT U, A, N, Y, Blank (space)

    PARes result convert in ASCII hexadecimal. « status » in the MPI response: U: ACS call carried out;
    A: ACS completed;
    N: Authentication failed;
    Y: Authentication success;
    Blank (space): ACS Timeout.

  • 3DSECURE_STATUS U, A, N, Y

    3-D Secure status.

  • 3DSECURE_XID hexadecimal string (40 max)

    3-D Secure X id.

  • 3DSECUREDISPLAYMODE main,popup,top,raw

    Define the 3-D Secure authentication page display mode:
    main: in the current frame;
    popup: in a browser popup;
    top: in the parent frame (useful in case of iframe integration);
    raw: to handle the redirection by yourself.

  • AGEVERIFICATION boolean

    Ask for a legal age verification.

  • ALIAS string(1-40)

    Identifier of a previously processed payment method.

  • ALIASMODE oneclick, subscription

    Indicates the ALIAS usage mode:
    oneclick indicates a one click or an online transaction;
    subscription indicates an offline transaction.

  • AMOUNT integer

    The transaction amount in the smallest money decimal (e.g. cents for euro).

  • AMOUNTS hash

    A hash of keys / values where keys are dates and values are the amounts to process:
    Dates have to be in format YYYY-MM-DD;
    Amounts in the smallest money decimal (e.g. cents for euro);
    See the dedicated section.

  • APIKEY string (16)

    The API key, private or public value (depending on the API KEY type) associated with an APIKEYID.

  • APIKEYID string (36)

    ID used to authenticate a transaction using APIKEY.

  • ASKIBAN boolean

    Displays a dedicated input field.

  • AUTHORIZATIONTYPE preauthorization, finalauthorization

    Type of authorization to process.

  • AVSCODE string(1)

    The Address Verification System result code. See the Address Verification System result codes section.

  • AVSMESSAGE string(1, 255)

    The Address Verification System result message. See the Address Verification System result codes section.

  • AVSPOSTALCODE string(1-9)

    The address postal code to submit to the Address Verification System.

  • AVSSTREETNAME string(4-50)

    The address street name to submit to the Address Verification System.

  • AVSSTREETNUMBER integer

    The address street number to submit to the Address Verification System.

  • BANK string(8-11)

    Bank Identifier Code (BIC).

  • BILLINGADDRESS string(1-50)

    The billing address. Be careful not to integrate any line breaks.

  • BILLINGCITY string(1-255)

    The billing city.

  • BILLINGCOUNTRY string(2)

    The country code (ISO_3166-1_alpha-2).

  • BILLINGFIRSTNAME string(1-15)

    The first name part of the billing address.

  • BILLINGLASTNAME string(1-15)

    The last name part of the billing address.

  • BILLINGMOBILEPHONE string(1-32)

    Billing mobile phone number in international format.

  • BILLINGPHONE string(1-32)

    Billing phone number in international format.

  • BILLINGPOSTALCODE string(1-9)

    The billing postal code.

  • BILLINGTITLE mr, miss, mrs

    The title used for the billing address name.

  • CARDCODE string(12-19)

    The user’s bank card’s Primary Account Number (PAN).

  • CARDCVV string(3-4)

    The user’s bank card’s cryptogram.

  • CARDFULLNAME string(1-255)

    The holder’s full name (as described on the payment method).

  • CARDTYPE string

    The payment method type.

  • CARDVALIDITYDATE date(MM-YY)

    Card expiry date.

  • CART[X][BRAND] string(1-100)

    Article brand.

  • CART[X][CATEGORY] computersandsoftware, electronics, appliances, homeandgarden, fashion, healthandbeauty, jewellery, sport, leisureandhobbies, carsandmotorbikes, furniture, / kidsandbaby, videogamesandconsoles, toysandgames, pets, foodanddrink, giftandflowers, entertainment, travel, auctionsandgroupbuying, servicesforindividuals, servicesforprofessionals

    Article category.

  • CART[X][DELIVERYEXPECTEDDATE] date(YYYY-MM-DD)

    Delivery Date.

  • CART[X][DELIVERYEXPECTEDDELAY] int (1-3)

    Number of days for delivery.

  • CART[X][DELIVERYLABEL] string(1-100)

    Delivery method name or description.

  • CART[X][DELIVERYSPEED] standard,express

    Speed of the delivery method. (Specify EXPRESS if under 48h).

  • CART[X][DELIVERYTYPE] storepickup, networkpickup, travelpickup, carrier, edelivery, other

    Delivery method.

  • CART[X][MERCHANTITEMID] string

    Item ID in the merchant system.

  • CART[X][NAME] string

    Item name.

  • CART[X][PRICE] int

    Unit price in cents, including potential taxes and discounts.

  • CART[X][DISCOUNT] float

    Applied discount in percentage. The decimal separator is the dot symbol.

  • CART[X][QUANTITY] integer

    Quantity of this item.

  • CART[X][SUBMERCHANTEXTERNALID] string

    Submerchant account identifier in the marketplace. This field allow a special value “OPERATOR” when the item is sold by the marketplace itself (and not a sub-merchant).

  • CART[X][TAX] float

    Applied taxes in percentage. The decimal separator is the dot symbol.

  • CART[X][TOTALAMOUNT] integer

    Total amount based on PRICE and QUANTITY.

  • CLIENTADDRESS string(1-510)

    The user’s address.

  • CLIENTDOB date(YYYY-MM-DD)

    The user’s date of birth.

  • CLIENTEMAIL email(5-255)

    The user’s email.

  • CLIENTGENDER m, f

    The cardholder gender.

  • CLIENTIDENT string(1-255)

    Unique identifier of the user in your application (e.g. a login or a primary key).

  • CLIENTREFERRER string(1-255)

    The user’s HTTP referrer URL.

  • CLIENTUSERAGENT string(1-255)

    The HTTP user agent.

  • CLIENTIP ipv4

    The user’s public IP address.

  • CREATEALIAS boolean

    Ask for a payment method ALIAS creation. Caution: this parameter is mutually exclusive with DISPLAYCREATEALIAS. See the dedicated section.

  • DATE date(YYYY-MM)

    Required and mutually exclusive with STARTDATE and ENDDATE. Month or day of data to be exported, formatted YYYY-MM or YYYY-MM-DD.

  • DESCRIPTION string(1-510)

    A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

  • DESCRIPTOR string

    The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

  • DISPLAYCREATEALIAS boolean

    Display a checkbox on the hosted form to ask the user to save his card data for future usage. Caution: this parameter is mutually exclusive with CREATEALIAS. See the dedicated section.

  • ENDDATE date(YYYY-MM)

    Required and mutually exclusive with DATE, works in pairs with STARTDATE. Period end date.

  • EXTERNALENTITYID int (1-10)

    Merchant account’s reference

  • EXTERNALREFERENCE int (9)

    Transaction’s reference (string left padded with 0 of 9 digits)

  • EXTRADATA string(1-255)

    Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

  • HASH string(64)

    The transaction’s hash as described in the dedicated section.

  • HFTOKEN string(1-36)

    A token to use with hosted fields integration. This token replace card holder data in a hosted field payment request.

  • HIDECARDFULLNAME no, yes

    Hide the fullname input on the hosted form. You must supply the CARDFULLNAME. See the dedicated section for more informations.

  • HIDECLIENTEMAIL no, yes

    Hide the CLIENTEMAIL input on the hosted form. You must supply the CLIENTEMAIL. See the dedicated section for more informations.

  • IBAN string(1-34)

    IBAN

  • IDENTIFICATIONDOCID string(1-32)

    Identification number of the holder’s ID document.

  • IDENTIFICATIONDOCTYPE taxstatement

    Holder’s ID document type.

  • IDENTIFIER string(1-32)

    Your processing account technical identifier.

  • LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, cs

    Configure the hosted form display language.

  • METADATA string(1-255)

    Additional transactional data. Contact your account manager for more informations.

  • ORDERID string(1-40)

    Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

  • OPERATIONTYPE authorization, payment, capture, refund, credit, void

    The action you want to process.

  • PAYMENTOPTION facilypay-3x, facilypay-3xsansfrais, facilypay-4x, facilypay-4xsansfrais, ANCV, EANCV, cofidis-3xcb, cofidis-4xcb, cofidis-4xpaypal, cofidis-1euro

    Specific options for certain payment methods.

  • PRESCORINGCODE string(20 max)

    Cofidis scoring value.

  • RECURRINGSEQUENCE registering, recurrence

    For merchants managing the registration of payment cards on their side, indicates the context of the use of a card:
    registering: the card has just been registred;
    recurrence: the card was already registred;

  • SCHEDULEID string(2-32)

    Schedule identifier.

  • SHIPTOADDRESS string(1-50)

    The shipping address.

  • SHIPTOCITY string(1-255)

    The shipping city.

  • SHIPTOCOMPANYNAME string(1-50)

    Name of the receiving company.

  • SHIPTOCOUNTRY string(2)

    The country code (ISO_3166-1_alpha-2 format)

  • SHIPTOFIRSTNAME string(1-15)

    Holder’s first name in the shipping address.

  • SHIPTOLASTNAME string(1-30)

    Holder’s last name in the shipping address.

  • SHIPTOMOBILEPHONE string(1-32)

    Shipping mobile phone number in international format.

  • SHIPTOPHONE string(1-32)

    Shipping phone number in international format.

  • SHIPTOPOSTALCODE string(1-9)

    The shipping postal code.

  • SHIPTOTITLE mr, miss, mrs

    Holder’s title in the shipping address.

  • SUBSCRIBERACCOUNT string(1-34)

    Subscriber’s IBAN.

  • SUBSCRIBERDOB date(YYYY-MM-DD)

    Subscriber’s date of birth.

  • SUBMERCHANTEXTERNALID string(32)

    Submerchant account identifier in the marketplace. This field allow a special value “OPERATOR” when the item is sold by the marketplace itself (and not a sub-merchant).

  • SUBSCRIBERNAME string(1-255)

    Subscriber’s name.

  • SUBSCRIBERZIPCODE string(1-9)

    Subscriber’s address postal code.

  • TIMEZONE string(1-128)

    Timezone / default value : UTC. Please see the Data sheet dedicated list of available timezones.

  • TRANSACTIONEXPIRATIONDATE datetime(yyyy-MM-dd HH:mm:ss)

    Form expiration date. By default, the date is UTC, the timezone can be specified by using the TIMEZONE parameter.

  • TRANSACTIONID string(1-32)

    Unique Dalenys transaction ID. Make sure to store this ID in your database.

  • TRAVELDEPARTUREDATE YYYY-MM-DD

    Travel departure date

  • TRAVELPASSENGERNAME string(1-20)

    Passenger name

  • TRAVELTICKETNUMBER string

    Ticket/document number, or PNR locator code.

  • TRAVELAGENCYCODE string(1-8)

    Travel agency code

  • TRAVELAGENCYNAME string(1-25)

    Travel agency name

  • TRAVELLEGS[X][TRAVELCARRIERCODE] string(2)

    Travel carrier code

  • TRAVELLEGS[X][TRAVELDESTINATIONLOCATIONCODE] string(3)

    Destination airport/city IATA code

  • TRAVELLEGS[X][TRAVELFAREBASISCODE] string(1-6)

    Fare basis code

  • TRAVELLEGS[X][TRAVELCARRIERNUMBER] string(1-5)

    Flight number excluding carrier code

  • TRAVELLEGS[X][TRAVELORIGINLOCATIONCODE] string(3)

    Origin airport/city IATA code

  • TRAVELLEGS[X][TRAVELSERVICECLASS] string(1-2)

    Service class

  • TRAVELLEGS[X][TRAVELSTOPOVERCODE] string(1)

    Stop over code

  • USETEMPLATE web, mobile

    Which custom payment form to use.

  • VERSION 3.0

    The API protocol version.

  • CALLBACKURL string(1-32)

    Web services callback URL (mutually exclusive with MAILTO). Exports destination URL.

  • COMPRESSION zip,gzip,bzip

    The compression method.

  • COLUMNS string(

    Column list to be included in an export. (List of compatible columns)

  • MAILTO email

    Web services callback email (mutually exclusive with CALLBACKURL).

  • SCOPE CLIENTSGROUP,CLIENT, ACCOUNT

    Account hierarchy to be exported.

  • STARTDATE date(YYYY-MM)

    Required and mutually exclusive with DATE, works in pairs with ENDDATE. Period start date.

  • TERMINALID integer

    Dalenys terminal id.

Callback parameters

  • 3DSECURE no, yes

    Merchant’s request for 3D Secure authentication.

  • 3DSECURE_XID hexadecimal (40 max)

    3-D Secure X id.

  • 3DSECUREAUTHENTICATIONSTATUS y, n, u, a

    Authentication status (Y = yes ; N = no ; U = unavailable; A = attempted).

  • 3DSECURESIGNATURESTATUS y, n

    Signature status.

  • 3DSGLOBALSTATUS ok, not_enrolled, unavailable, not_required

    Global status.

  • ALIAS string(1-40)

    Identifier of a previously processed payment method.

  • AMOUNT integer

    The transaction amount in the smallest money decimal (e.g. cents for euro).

  • BANK string(8-11)

    Bank Identifier Code (BIC).

  • CARD3DSECUREENROLLED y, n, u

    Card 3-D Secure enrollment status.

  • CARDCODE string(12-19)

    The user’s bank card’s Primary Account Number (PAN)

  • CARDCOUNTRY string(2)

    The country code (format ISO_3166-1_alpha-2).

  • CARDFULLNAME string(1-255)

    The holder’s full name (as described on the payment method).

  • CARDNETWORK VISA, AMERICAN EXPRESS, MASTERCARD, BANCONTACT, CARTE BLEUE, UNKNOWN

    The cardholder’s bank card network.

  • CARDTYPE string

    The payment method type.

  • CARDVALIDITYDATE date(MM-YY)

    Card expiry date.

  • CHARGEBACKDATE date(YYYY-MM-DD)

    Chargeback date.

  • CHARGEBACKTYPE chargeback, representment

    Chargeback type.

  • CLIENTEMAIL email(5-255)

    The user’s email.

  • CLIENTIDENT string(1-255)

    Unique identifier of the user in your application (e.g. a login or a primary key).

  • CURRENCY string(3)

    Currency code (ISO 4217 format).

  • DESCRIPTION string(1-510)

    A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

  • DESCRIPTOR string

    The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

  • EXECCODE string(4)

    The operation result code. (See the complete list of execution code)

  • EXTERNALENTITYID int (1-10)

    Merchant account’s reference

  • EXTERNALREFERENCE int (9)

    Transaction’s reference (string left padded with 0 of 9 digits)

  • EXTRADATA string(1-255)

    Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

  • HASH string(64)

    The transaction’s hash as described in the dedicated section.

  • IBAN string(1-34)

    IBAN

  • IDENTIFIER string(1-32)

    Your processing account technical identifier.

  • LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, cs

    Configure the hosted form display language.

  • MESSAGE string(no length limit)

    The operation result description linked to EXECCODE.

  • METADATA string(1-255)

    Additional transactional data. Contact your account manager for more informations.

  • OPERATIONTYPE authorization, payment, capture, refund, credit, void

    The action you want to process.

  • ORDERID string(1-40)

    Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

  • PP_ADDRESS_STATUS none, confirmed, unconfirmed

    Status of street address on file with PayPal.

  • PP_PAYER_ID string(13)

    ID of Paypal payer’s account

  • PP_PAYER_STATUS none, canceled-reversal, completed, denied, expired, failed, in-progress, partially-refunded, pending, refunded, reversed, processed, voided, completed-funds-held

    The status of the payment.

  • PP_PROTECTION_ELIGIBILITY eligible, partiallyeligible, ineligible

    The kind of seller protection in force for the transaction.

  • PP_PROTECTION_ELIGIBILITY_TYPE itemnotreceivedeligible, unauthorizedpaymenteligible, ineligible

    The kind of seller protection in force for the transaction.

  • PP_SHIP_TO_CITY string(40 Bytes)

    Shipping city.

  • PP_SHIP_TO_COUNTRYCODE string(2)

    Country code.

  • PP_SHIP_TO_NAME string(1-32)

    Holder’s shipping last name.

  • PP_SHIP_TO_STREET string(1-100)

    Shipping street address.

  • PP_SHIP_TO_ZIP string(1-20)

    U.S. ZIP code or other country-specific postal code.

  • PP_TRANSACTION_ID string(20 max)

    Unique transaction ID of the payment.

  • REDIRECTHTML string(no length limit)

    HTML content to display to the user to continue the processing. The string is base64 encoded.

  • REDIRECTPOSTPARAMS string(no length limit)

    The POST parameters to send when 3DSECUREDISPLAYMODE is valued to “raw”. The redirection should send the user to the url pointed by REDIRECTURL.

  • REDIRECTURL string(no length limit)

    The url to redirect the user to continue the processing.

  • REQUESTID string(1-32)

    Unique Dalenys request ID. Make sure to store this ID in your database.

  • TAGS string(no max length)

    Tags set by the Dalenys’s rule engine

  • TERMINALID integer

    Dalenys terminal id.

  • TRANSACTIONID string(1-32)

    Unique Dalenys transaction ID. Make sure to store this ID in your database.

  • VERSION 3.0

    The API protocol version.

Export columns

  • 3DSECI string (1)

    Electronic Commerce Indicator.

  • 3DSECURE no, yes

    Ask for a 3-D Secure authentication.

  • 3DSECUREAUTHENTICATIONSTATUS y, n, u, a

    Authentication status (Y = yes ; N = no ; U = unavailable; A = attempted).

  • 3DSECURESIGNATURESTATUS y, n

    Signature status.

  • 3DSGLOBALSTATUS ok, not_enrolled, unavailable, not_required

    Global status.

  • 3DSLIABILITYSHIFT ‘yes’, ‘no’

    3D-Secure Liability Shift.

  • ADDITIONAL DATA string

    Bank response additional data from authorization request.

  • ALIAS string(1-40)

    Identifier of a previously processed payment method.

  • ALIASMODE oneclick, subscription

    Indicates the ALIAS usage mode:
    oneclick indicates a one click or an online transaction;
    subscription indicates an offline transaction.

  • AMOUNT integer

    The transaction amount in the smallest money decimal (e.g. cents for euro).

  • AMOUNT IN BILLING CURRENCY integer

    Transaction amount in the billing currency.

  • ARN string

    Acquirer Reference Number.

  • AUTHENTICATION string

    Cardholder authentication mechanism.

  • AUTHORIZATION NUMBER string

    Authorization number (POS only).

  • AUTHORIZATIONTYPE preauthorization, finalauthorization

    Type of authorization to process.

  • AUTHORIZEDBY string

    Authorization transaction ID (captures only).

  • AVS CODE string(1)

    The Address Verification System result code. See the Address Verification System result codes section.

  • AVS MESSAGE string(1, 255)

    The Address Verification System result message. See the Address Verification System result codes section.

  • BANK COLLECTION NUMBER string(1-50)

    Bank collection number (POS only).

  • BILLING ADDRESS string(1-50)

    The billing address as specified by the merchant in the original payment request.

  • BILLING CITY string(1-25)

    The billing city as specified by the merchant in the original payment request.

  • BILLING COUNTRY string(2)

    The billing country (ISO_3166-1_alpha-2) as specified by the merchant in the original payment request.

  • BILLING CURRENCY string(3)

    Billing and payment currency.

  • BILLING FIRST NAME string(1-15)

    The first name part of the billing address as specified by the merchant in the original payment request.

  • BILLING LAST NAME string(1-15)

    The last name part of the billing address as specified by the merchant in the original payment request.

  • BILLING MOBILE PHONE string(1-32)

    Billing mobile phone number in international format as specified by the merchant in the original payment request.

  • BILLING NETWORK string(1-10)

    Billing network.

  • BILLING PHONE string(1-32)

    Billing phone number in international format as specified by the merchant in the original payment request.

  • BILLING POSTAL CODE string(1-9)

    The billing postal code as specified by the merchant in the original payment request.

  • BILLING TITLE mr, miss, mrs

    The title used for the billing address name.

  • BILLING VAT FEES integer

    Billing fees on transaction (VAT fees).

  • BILLINGFEES EX. VAT integer

    Billing fees on transaction (ex. VAT).

  • BILLINGFEES EXCHANGE RATE integer

    Exchange rate used to calculate the fee in billing currency

  • BILLINGFEES INCL. VAT integer

    Billing fees on transaction (incl. VAT).

  • BRAND string

    Equipement brand (POS only).

  • CAPTUREBY string

    Capture transaction IDs (separated by commas) if this transaction is captured (authorization only).

  • CARD PRODUCT string

    Card product.

  • CARD SERVICE TYPE debit,credit

    Card service type (Debit/Credit)

  • CARD SUBTYPE string

    Card type (advanced).

  • CARD3DSECUREENROLLED y, n, u

    Card 3-D Secure enrollment status.

  • CARDBANK string

    Cardholder’s bank.

  • CARDCODE string(12-19)

    The user’s bank card’s Primary Account Number (PAN)

  • CARDCODE 6X4 integer

    First six and last 4 digits of holder’s card.

  • CARDCOUNTRY string(2)

    The country code (format ISO_3166-1_alpha-2).

  • CARDFULLNAME string(1-255)

    The holder’s full name (as described on the payment method).

  • CARDTYPE string

    The payment method type.

  • CARDVALIDITYDATE date(MM-YY)

    Card expiry date.

  • CB2A int(2)

    Bank response code from authorization request.

  • CHARGEBACK CODE string(1-255)

    Chargeback reason code.

  • CHARGEBACKAMOUNT integer

    The chargeback amount in the smallest money decimal (e.g. cents for euro).

  • CHARGEBACKDATE date(YYYY-MM-DD)

    Chargeback date.

  • CHARGEBACKSTATUS chargeback, representment

    Chargeback type.

  • CHARGED_DATE date(YYY-MM-DD)

    Date of commission payment to the merchant.

  • CHARGED_REFERENCE string(0-45)

    Reference of the transfer in which commissions were taken for the transaction.

  • CLIENTADDRESS string(1-510)

    The user’s address.

  • CLIENTDOB date(YYYY-MM-DD)

    The user’s date of birth.

  • CLIENTEMAIL email(5-255)

    The user’s email.

  • CLIENTIDENT string(1-255)

    Unique identifier of the user in your application (e.g. a login or a primary key).

  • CLIENTIP ipv4

    The user’s public IP address.

  • CLIENTREFERRER string(1-255)

    The user’s HTTP referrer URL.

  • CLIENT_IDENTIFIER string

    Client export identifier (Export Sevices only).

  • CLIENT_INTERNAL_ID string(1-125)

    Unique Client identifier.

  • CLIENTUSERAGENT string(1-255)

    The HTTP user agent.

  • COLLECTION DATE datetime(yyyy-MM-dd HH:mm:ss)

    Settlement date.

  • COLLECTION NUMBER integer

    Settlement number (only for POS transactions)

  • CURRENCY string(3)

    Currency code (ISO 4217 format).

  • DATE date(YYYY-MM)

    Required and mutually exclusive with STARTDATE and ENDDATE. Month or day of data to be exported, formatted YYYY-MM ou YYYY-MM-DD.

  • DESCRIPTION string(1-510)

    A short description of the operation, can be used to trigger fraud actions. Don’t hesitate to ask your Payment Manager for some advice on this topic.

  • DESCRIPTOR string

    The transaction label sent to the bank network. The transaction will display with this label on the user’s bank statement.

  • EPT RANK int(3)

    Payment terminal rank (only for POS transactions).

  • EXECCODE string(4)

    The operation result code. (See the complete list of execution code)

  • EXTERNALREFERENCE int (9)

    Transaction’s reference (string left padded with 0 of 9 digits)

  • EXTRADATA string(1-255)

    Free field (Dalenys will send you back the content of the EXTRADATA you specified ahead).

  • FINANCIALSTATE being processed,collected,paid

    Transaction financial state (‘Being processed’; ‘Collected’ ; ‘Paid’).

  • FORM ATTEMPT 1,2,3,4

    Form attempt number

  • IDENTIFIER string(1-32)

    Your processing account technical identifier.

  • INTERCHANGE FEE integer

    Interchange fee.

  • IP COUNTRY ipv4

    holder’s IP country.

  • LANGUAGE fr, en, de, es, it, nl, zh, ru, pt, cs

    Configure the hosted form display language.

  • LAST NOTIFICATION CONTENT string(1-45)

    Last notification content.

  • LAST NOTIFICATION HTTP CODE sent,succeeded,pending,failure

    Last notification http code.

  • LAST NOTIFICATION RESULT sent,succeeded,pending,failure

    Last notification result.

  • LOCATION string(1-35)

    Equipment location: open field that can be modified on the POS inventory page of your extranet (POS only).

  • MERCHANT COUNTRY string(2)

    Merchant’s country used in the interchange calculation.

  • MESSAGE string(no length limit)

    The operation result description linked to EXECCODE.

  • METADATA string(1-255)

    Additional transactional data. Contact your account manager for more informations.

  • MID integer

    Merchant Identification.

  • MODEL int(3)

    Equipment model (POS only).

  • NATURE retrieval request,chargeback,representment

    Nature of the operation. Same as OPERATIONTYPE until a retrieval request, a chargeback or representment event occurs. In this case, indicates ‘retrieval request’, ‘chargeback’ or ‘representment’.

  • NFC y,n

    Contactless transaction (POS only)(‘yes’; ‘no’).

  • OPERATIONTYPE authorization, payment, capture, refund, credit, void

    The action you want to process.

  • OPPOTOTA_ENTRY_DATE datetime(yyyy-MM-dd HH:mm:ss)

    Oppotota entry date.

  • OPPOTOTA_REASON lost,stolen,did not reach cardholder,counterfeit,misuse

    Oppotota reason.

  • ORDERID string(1-40)

    Unique ID associated to an order in the merchant’s database (as specified in your initial POST request)

  • PAYMENT OPTION facilypay-3x, facilypay-3xsansfrais, facilypay-4x, facilypay-4xsansfrais, ANCV, EANCV

    Facily Pay and ANCV payment options.

  • POS TERMINAL TYPE ept,mpos, kiosk

    POS terminal type (‘EPT’; ‘mPOS’; ‘Kiosk’)(POS only)

  • PP_ADDRESS STATUS none, confirmed, unconfirmed

    Status of street address on file with PayPal.

  • PP_PAYER ID STATUS string(13)

    ID of Paypal payer’s account

  • PP_PAYER STATUS none, canceled-reversal, completed, denied, expired, failed, in-progress, partially-refunded, pending, refunded, reversed, processed, voided, completed-funds-held

    The status of the payment.

  • PP_PROTECTION ELIGIBILITY eligible, partiallyeligible, ineligible

    The kind of seller protection in force for the transaction.

  • PP_PROTECTION ELIGIBILITY TYPE itemnotreceivedeligible, unauthorizedpaymenteligible, ineligible

    The kind of seller protection in force for the transaction.

  • PP_SHIP TO CITY string(40 Bytes)

    Shipping city.

  • PP_SHIP TO COUNTRY CODE string(2)

    Country code.

  • PP_SHIP TO NAME string(1-32)

    Holder’s shipping last name.

  • PP_SHIP TO STREET string(1-100)

    Shipping street address.

  • PP_SHIP TO ZIP CODE string(1-20)

    U.S. ZIP code or other country-specific postal code.

  • PP_TRANSACTION ID string(20 max)

    Unique transaction ID of the payment.

  • PRESCORINGCODE string(20 max)

    Cofidis scoring value.

  • REASON string(1-125)

    Rule Description.

  • REF ARCH string(1-12)

    Retrieval reference number.

  • REFUND TRANSFER REFERENCE string(1-32)

    Refund transfer reference.

  • REFUND TRANSFER STATUS pending,failed,succeeded

    Refund transfer status (‘Pending’, ‘Failed’, ‘Succeeded’).

  • REFUNDED string

    Refunded transaction ID, if OPERATIONTYPE=’refund’.

  • REFUNDEDBY string(0-n)

    Refund transaction IDs (separated by commas ,) if this transaction is refunded.

  • REFUNDTYPE refund,cancel

    Refund type (‘refund’;’cancel’).

  • RETRY string(no length limit)

    Payment schedule information (retry number - number of retries).

  • RULE APPLIED string(1-125)

    Rule applied by fraud rule engine.

  • RULE IDS string(1-255)

    Rule IDs applied by fraud rule engine.

  • SCHEDULE string(no length limit)

    Payment schedule information (installment number - number of instalments).

  • SCHEDULEID string(2-32)

    Schedule identifier.

  • SERIAL NUMBER string(12)

    Payment terminal serial number (POS only).

  • SHIP TO ADDRESS string(1-50)

    The shipping address.

  • SHIP TO CITY string(1-255)

    The shipping city.

  • SHIP TO COMPANY NAME string(1-50)

    Name of the receiving company.

  • SHIP TO COUNTRY string(2)

    The shipping country (ISO_3166-1_alpha-2 format).

  • SHIP TO FIRST NAME string(1-15)

    Holder’s first name in the shipping address.

  • SHIP TO LAST NAME string(1-30)

    Holder’s last name in the shipping address.

  • SHIP TO MOBILE PHONE string(1-32)

    Shipping mobile phone number in international format.

  • SHIP TO PHONE string(1-32)

    Shipping phone number in international format.

  • SHIP TO POSTAL CODE string(1-9)

    The shipping postal code.

  • SHIP TO TITLE mr, miss, mrs

    Holder’s title in the shipping address..

  • SIRET string

    SIRET number.

  • SUBMERCHANTS EXTERNAL IDS string(32)

    Sub-merchants external ID as received in the transaction request.

  • TAGS string(no max length)

    Tags set by the Dalenys’s rule engine

  • TRADE NAME

    Trade name.

  • TRANSACTION EXPIRATION DATE datetime(yyyy-MM-dd HH:mm:ss)

    Transaction expiration date.

  • TRANSACTIONID string(1-32)

    Unique Dalenys transaction ID. Make sure to store this ID in your database.

  • TRANSFER REFERENCE string(1-45)

    Transfer reference.

  • UDV string(10)

    Dalenys merchant account.

  • VERSION 3.0

    The API protocol version.

  • VISA MC FEE float

    Fees charged by the card schemes (Visa or Mastercard).

  • VOIDED string(1-40)

    Voided transaction ID.

  • VOIDEDBY string(1-40)

    Void transaction ID.

  • VOIDTYPE authorization,capture,payment,refund,credit

    Void type.