| Name/Description | Format/Values |
|---|---|
|
amount Payment amount in the smallest currency unit (cents for euro) . |
Format : integer | Maximum length : 12 E.g.: 4525 for EUR 45.25 |
|
currency Numeric currency code to be used for the payment, in compliance with the ISO 4217 standard. |
Format : string | Maximum length : 3 E.g.: EUR |
|
orderId Order reference defined by the merchant. Does not support UTF-8 characters. |
Format : string | Maximum length : 64 E.g. : E.g : myOrderId-1234 |
|
customer.email Buyer’s e-mail address |
Format : string | Maximum length : 150 E.g.: sample@example.com |
|
customer.reference Buyer ID on the merchant side. |
Format : string | Maximum length : 63 E.g.: myCustomerRef-123456 |
|
customer.accountDetails.creationDate Date and time in UTC format of the user account creation on the merchant website, in YYYYMMDDHHMMSS format. |
Format : string | Maximum length : 25 E.g.: 2025-01-14T00:00:00+00:00 |
|
customer.accountDetails.creationDate
Date and time in UTC format of the user account creation on the merchant website, in YYYYMMDDHHMMSS format.
If the field is empty or missing, the platform Lyra Collect sends a default value: No account (guest order). |
Format : string | Maximum length : 25 E.g.: 2025-01-14T00:00:00+00:00 |
|
customer.billingDetails.identityCode National identifier. Allows to identify each citizen within a country. |
Format : string | Maximum length : 150 |
|
customer.billingDetails.language Buyer's language code, according to ISO 639-1. Allows you to specify the language in which payment confirmation emails are sent. |
Format : string | Maximum length : 5 |
|
customer.billingDetails.category Buyer type |
Format : string | Maximum length : 7
Values:
|
|
customer.billingDetails.legalName Legal name. For a payment usingOney, this field is required ifcustomer.billingDetails.categoryhas the valueCOMPANY. |
Format : string | Maximum length : 100 |
|
customer.billingDetails.firstName Buyer's first name |
Format : string | Maximum length : 63 E.g.: Albert |
|
customer.billingDetails.lastName Buyer’s last name. |
Format : string | Maximum length : 63 E.g.: Durant |
|
customer.billingDetails.streetNumber Street number of the billing address |
Format : integer | Maximum length : 5 E.g. : 2 |
|
customer.billingDetails.address Postal address |
Format : string | Maximum length : 255 E.g. : Rue de l'innovation |
|
customer.billingDetails.address2 Address line 2 |
Format : string | Maximum length : 255 E.g.: |
|
customer.billingDetails.zipCode Zip code |
Format : integer | Maximum length : 64 E.g.: 31000 |
|
customer.billingDetails.city City |
Format : string | Maximum length : 128 E.g.: Labège |
|
customer.billingDetails.state State / Region |
Format : string | Maximum length : 127 E.g. : Occitanie |
|
customer.billingDetails.country Country code in compliance with the ISO 3166 alpha-2 standard |
Format : string | Maximum length : 2 E.g. : FR for France |
|
customer.billingDetails.phoneNumber Shipping buyer’s phone number |
Format : string | Maximum length : 32
E.g :
|
|
customer.billingDetails.phoneNumber
(wherecustomer.billingDetails.cellPhoneNumber) Shipping buyer’s phone number We recommend to send the international code of the buyer’s phone number. With the international code, the countryside (customer.billingDetails.country) becomes optional. |
Format : string | Maximum length : 32 Examples using the international dialing code:
|
|
customer.billingDetails.cellPhoneNumber Cell phone number |
Format : string | Maximum length : 32
E.g :
|
|
customer.shoppingCart.cartItemInfo.productLabel Product name |
Format : string | Maximum length : 255 E.g.: "Brandt Microwave" |
|
customer.shoppingCart.cartItemInfo.productAmount Payment amount in the smallest currency unit (cents for euro) . |
Format : integer | Maximum length : 12 E.g.: 4525 for EUR 45.25 |
|
customer.shoppingCart.cartItemInfo.productQty Product quantity |
Format : integer | Maximum length : 12 E.g.: 1 |
|
customer.shoppingCart.cartItemInfo.productRef Product reference. |
Format : string | Maximum length : 12 E.g. : "BRAN4588" |
|
customer.shoppingCart.cartItemInfo.productType Type of product |
Format : string | Maximum length : 23 E.g. : "FOOD_AND_GROCERY" |
|
customer.shippingDetails.firstName First name of the recipient |
Format : string | Maximum length : 63 E.g.: Albert |
|
customer.shippingDetails.lastName Recipient's last name |
Format : string | Maximum length : 63 E.g.: Durant |
|
customer.shippingDetails.phoneNumber Phone number |
Format : string | Maximum length : 32
E.g :
|
|
customer.shippingDetails.streetNumber Street number of the delivery address. |
Format : integer | Maximum length : 64 E.g. : 2 |
|
customer.shippingDetails.address Postal address |
Format : string | Maximum length : 255 E.g. : Rue de l'innovation |
|
customer.shippingDetails.address2 Address line 2 |
Format : string | Maximum length : 255 E.g.: |
|
customer.shippingDetails.zipCode Zip code |
Format : integer | Maximum length : 64 E.g.: 31000 |
|
customer.shippingDetails.city City |
Format : string | Maximum length : 128 E.g.: Labège |
|
customer.shippingDetails.state State / Region |
Format : string | Maximum length : 127 E.g. : Occitanie |
|
customer.shippingDetails.country Country code in compliance with the ISO 3166 alpha-2 standard |
Format : string | Maximum length : 2 E.g. : FR |
|
customer.shippingDetails.shippingMethod Shipping mode. |
Format : string | Maximum length : 24
Values:
|
|
customer.shippingDetails.shippingSpeed Shipping delay. |
Format : string | Maximum length : 8
Values:
|