PaymentOrder/Update web service

POSThttps://api.lyra.com/api-payment/V4/Charge/PaymentOrder/Update

Le Web Service PaymentOrder/Update permet de mettre à jour des ordres de paiement créés avec le Web Service Charge/CreatePaymentOrder.

Only the payment orders in progress ( RUNNING status) can be updated.

Consultez le guide d'intégration : Modifier un ordre de paiement.

Input parameters

paymentOrderId

Unique reference of the payment order generated by the gateway.

Format

amount

Payment amount in its smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

currency

Payment currency. Alphabetic code in uppercase according to alpha-3 (ISO 4217).

Eg: "EUR" for the euro.

Format

Possible values

. The possible values are:

Currency	ISO 4217 ENCODING	Fractional unit
Australian dollar (036)	AUD	2
Canadian dollar (124)	CAD	2
Swiss franc (756)	CHF	2
Danish crown (208)	DKK	2
Euro (978)	EUR	2
Pound Sterling (826)	GBP	2
Japanese yen (392)	JPY	0
Norwegian crown (578)	NOK	2
Swedish krona (752)	SEK	2
US dollar (840)	USD	2

orderId

Order reference defined by the Merchant.Does not support UTF-8 characters.

Format

channelType

Path: channelOptions.channelType

Type of payment order to be created. The default value is URL.

Format

Possible values

. The possible values are:

value	Description
MAIL	The payment order is sent by e-mail to the Buyer.
URL	Only the payment URL returned in the response is created.
SMS	The payment order is sent to the Buyer by SMS.
WHATSAPP	The payment order is sent to the Buyer as a WhatsApp message.
INVOICE	The payment order is sent in the form of an invoice to be paid.
IVR	The payment order is created and payable via the IVS

bcc

Path: channelOptions.mailOptions.bcc

BCC ("Blind Carbon Copy" or "Invisible Carbon Copy"). List of additional recipients of the payment order. These addressees are not visible to the main recipient. Use the semicolon ";" as a separator between each address.

Format

body

Path: channelOptions.mailOptions.body

Allows you to customize the e-mail body. If the parameter is left blank, the default template will be applied.

Format

To customize the body of the e-mail, you can use the variables below:

value	Description
%url%	URL of the payment order. If this variable is absent, the payment link will be added automatically at the end of the message.
%amount%	Payment amount and currency.
%start_date%	Date of payment order creation.
%end_date%	Expiry date of the payment order.
%shop_name%	Name of your shop as defined in the Back Office.
%reference%	Order reference.
%shop_url%	URL of your shop.
%shop_contact%	E-mail address of the "shop administrator", as defined in the Back Office.

Example: Hello, this e-mail contains a payment link for %amount% , valid until %end_date%. To confirm the payment, click on the following link: %url%.

recipient

Path: channelOptions.mailOptions.recipient

E-mail recipient.

Format

subject

Path: channelOptions.mailOptions.subject

Allows you to customize the e-mail subject. This parameter is mandatory unless you specify a valid template name in the channelOptions.mailOptions.template parameter.

Format

To customize the e-mail subject, use the variables below:

value	Description
%url%	URL of the payment order, must be inserted in the body of the e-mail.
%amount%	Payment amount and currency.
%start_date%	Date of payment order creation.
%end_date%	Expiry date of the payment order.
%shop_name%	Name of your shop as defined in the Back Office.
%reference%	Order reference.
%shop_url%	URL of your shop.
%shop_contact%	E-mail address of the "shop administrator", as defined in the Back Office.

Example: %reference% offer valid from %start_date% to %end_date% for an amount of %amount%.

template

Path: channelOptions.mailOptions.template

Name of the template to be used for generating the e-mail. The template must exist in the Back Office for this to work.

Each e-mail template is associated with a language (or locale). To use a template, you must make sure that you transmit the right language in the locale parameter.

If the template is not found an error will be returned. If you have set a value in the subject and body parameters, the template will be ignored.

Format

message

Path: channelOptions.smsOptions.message

SMS message.

Format

phoneNumber

Path: channelOptions.smsOptions.phoneNumber

Phone number for sending the SMS.

Format

phoneNumber

Path: channelOptions.whatsAppOptions.phoneNumber

Phone number for sending WhatsApp messages.

Format

ivrPaymentOrderId

Path: channelOptions.ivrOptions.ivrPaymentOrderId

This field is normally filled in automatically by the platform. If the merchant has specific functional constraints, this field can exceptionally be overloaded with its own numerical reference, guaranteeing its uniqueness.

Format

formAction

Allows you to define the desired type of behavior when creating the transaction.

Possible values

. The possible values are:

value	Description
PAYMENT	Creating a simple transaction. Default behavior.
REGISTER	Creation of the alias without payment. The amount must be transmitted to 0.
REGISTER_PAY	Token creation during a payment.
REGISTER_UPDATE	Modification of information associated with the token.
REGISTER_UPDATE_PAY	Updating information associated with the token during a payment.
ASK_REGISTER_PAY	Payment with an offer for the cardholder to create a token.
null	If the value is null or undefined, the PAYMENT value is applied.

Format

dataCollectionForm

Use of the data collection form. If set to true , the data collection form will be displayed before the payment form.

Format

expirationDate

Expiration date and time of the payment order, in ISO-8601 format.

Format

locale

Regional (or local) parameter in cc_XX format, where:

cc represents the language code (two lowercase characters according to ISO-639 (example "de" for German, "en" for English, "fr" for French).
XX represents the country code (two uppercase characters according to ISO-3166 (e.g.: "DE" for Germany, "FR" for France, "GB" for the UK).

Allows you to set the language of the payment pages and the confirmation e-mail. If the parameter is not set, the language of the shop is used.

Format

merchantComment

Comment associated with the payment order. It is used, for example, to specify a reference about the payment order sender.

Format

paymentReceiptEmail

Buyer's e-mail address to which the payment receipt is sent. This feature can only work if the notification rule "Confirmation e-mail sent to the buyer" is enabled in the Back Office.

Format

taxAmount

Amount of taxes for the entire order expressed in the smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

taxRate

Used by some payment methods in Latin America. Allows you to transmit the tax rate applied to the entire order. The value must be the percentage to apply (21 for 21%).

Format

allowDCFAmountUpdate

allowDCFAmountUpdate is used to define whether the amount can be changed in the data collection form. This field can only be used if the dataCollectionForm field is set to true.

Format

Possible values

. The possible values are:

value	Description
NONE	The amount cannot be changed. Default behavior.
LOWER	The amount can only be changed downwards.
GREATER	The amount can only be changed upwards.
LOWER_AND_GREATER	The amount can be changed up or down.
null	If the value is null or undefined, NONE is applied.

Format

metadata

Custom values linked to the transaction, in JSON format.

Example of a call

For example, to pass a custom value, add the following to your query:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

This value will be returned in the newly created transaction object.

You can also use the metadata “ orderInfo1 ”, “ orderInfo2 ” and “ orderInfo3 ” to send complementary information about the order.

This data can be found later in the Extra tab of the transaction details via your Merchant Back Office.

Format

returnMode

returnMode allows you to specify the data transmission method used when returning to the merchant site.

Possible values

. The possible values are:

value	Description
NONE	No parameters will be passed to the URL for returning to the merchant site.
GET	The return fields will be passed to the return URL as an HTTP GET form (in the "query string").
POST	The return fields will be passed to the return URL as an HTTP POST form. If the return to the shop is executed in a non-https environment, the browser will display a security pop-up to the buyer.
null	If the value is null or undefined, NONE is applied.

Format

returnUrl

returnUrl allows to define the URL to which the buyer will be redirected by default after pressing the Return to shop button, if the errorUrl , refusedUrl , successUrl or cancelUrl URLs are not specified.

If the field is not transmitted, the Merchant Back Office configuration will be applied.

If no URL is defined in the Merchant Back Office or in the form, the Return to shop button will redirect the buyer to the merchant URL (URL field in the shop configuration).

Format

cancelUrl

cancelUrl allows you to define the URL to which the buyer will be redirected if they press Cancel and return to the shop before proceeding to the payment.

Format

successUrl

successUrl allows you to define the URL to which the buyer will be redirected in case of successful payment, after pressing the Return to shop button.

Format

refusedUrl

refusedUrl allows you to define the URL to which the buyer will be redirected in case of refusal, after pressing the Return to shop button.

Format

errorUrl

errorUrl allows you to define the URL to which the buyer will be redirected in case of an internal processing error.

Format

postWalletUrl

postWalletUrl allows you to define the URL to which the buyer will be redirected when making a two-step payment using a wallet.

This URL is used for transmitting information related to the buyer's choice (e-mail, delivery address, payment method, etc.).

Based on these elements, the merchant can decide what action to take (adjust the shipping costs, register the payment method, etc.) before allowing the buyer to finalize their payment.

Format

ipnTargetUrl

You can override the Instant Payment Notification (also called IPN) in the payment form in case you use one shop for various sales channels, payment types, languages, etc.

Format

redirectSuccessTimeout

Allows to define a delay in seconds before an automatic redirection to the merchant website at the end of an accepted payment.

Its value is between 0 and 300 s.

After this time, the buyer will be redirected to the URL entered in the successUrl field. If this field is not filled in, the buyer will be redirected to the return URL filled in the returnUrl field or to the return URL filled in the bom. If the return URL is not defined, it will be redirected to the store URL.

Format

redirectErrorTimeout

Allows to define a delay in seconds before an automatic redirection to the merchant website at the end of a declined payment.

Its value is between 0 and 300 s.

After this time, the buyer will be redirected to the URL entered in the errorUrl field. If this field is not filled in, the buyer will be redirected to the return URL filled in the returnUrl field or to the return URL filled in the bom. If the return URL is not defined, it will be redirected to the store URL.

Format

customer.reference

Buyer ID on the merchant side.

Format

customer.email

Buyer's e-mail address.

Email structure specifications: RFC-2822

Format

address

Path: customer.billingDetails.address

Billing address.

Warning: the characters > and < are not authorized.

Format

address2

Path: customer.billingDetails.address2

Second line of the billing address.

Warning: the characters > and < are not authorized.

Format

Values	Description
PRIVATE	Individual buyer type.
COMPANY	Company buyer type.

cellPhoneNumber

Path: customer.billingDetails.cellPhoneNumber

Buyer's cell phone number.

Accepts all formats:

Examples:

0623456789
+33623456789
0033623456789
(+34) 824 65 43 21
87 77 12 34

Format

city

Path: customer.billingDetails.city

City of the billing address.

Format

country

Path: customer.billingDetails.country

Buyer's country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).

Format

Possible values

Examples of possible values:

Country	Code
AUSTRIA	AT
BRAZIL	BR
CORSICA	FR
IVORY COAST	CI
FRANCE	FR
GUADELOUPE	GP
INDIA	IN
MARTINIQUE	MQ
NEW CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
FRENCH POLYNESIA	PF

district

Path: customer.billingDetails.district

District of the billing address.

Format

firstName

Path: customer.billingDetails.firstName

Buyer's first name.

Format

identityCode

Path: customer.billingDetails.identityCode

National identifier. Allows to identify each citizen within a country.

Format

identityType

Path: customer.billingDetails.identityType

ID type.

Format

language

Path: customer.billingDetails.language

Buyer's language code, according to ISO 639-1.

Specify the language in which payment confirmation e-mails are sent.

Format

Possible values

Examples of possible values:

Language	Code
German (Germany)	DE
English (United Kingdom)	EN
English (United States)	EN
Chinese (Traditional)	ZH
Spanish (Spain)	ES
Spanish (Chile)	ES
French (France)	FR
Italian (Italy)	IT
Japanese (Japan)	JP
Dutch (the Netherlands)	NL
Polish (Poland)	PL
Portuguese (Brazil)	PT
Portuguese (Portugal)	PT
Russian (Russia)	RU

lastName

Path: customer.billingDetails.lastName

Buyer's last name.

Format

legalName

Path: customer.billingDetails.legalName

Legal name.

Format

phoneNumber

Path: customer.billingDetails.phoneNumber

Buyer's phone number.

Accepts all formats:

Examples:

0123456789
+33123456789
0033123456789
(00.571) 638.14.00
40 41 42 42

Format

state

Path: customer.billingDetails.state

Region (state) of the billing address. It is recommended, but not mandatory, to pass the value in ISO-3166-2.

Format

streetNumber

Path: customer.billingDetails.streetNumber

Street number of the billing address.

Accepted characters:

Alphabetical characters (from "A" to "Z" and from "a" to "z")
Space

Format

title

Path: customer.billingDetails.title

Buyer's title.

Examples:

Format

zipCode

Path: customer.billingDetails.zipCode

Zip code of the billing address.

Format

address

Path: customer.shippingDetails.address

Shipping address.

Warning: the characters > and < are not authorized.

Format

address2

Path: customer.shippingDetails.address2

Second line of the shipping address.

Warning: the characters > and < are not authorized.

Format

Values	Description
PRIVATE	Individual buyer type.
COMPANY	Company buyer type.

city

Path: customer.shippingDetails.city

Shipping city.

Format

country

Path: customer.shippingDetails.country

Shipping country (in uppercase, in accordance with the ISO 3166-1 alpha-2 country codes).

Format

Possible values

Examples of possible values:

Country	Code
AUSTRIA	AT
BRAZIL	BR
CORSICA	FR
IVORY COAST	CI
FRANCE	FR
GUADELOUPE	GP
INDIA	IN
MARTINIQUE	MQ
NEW CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
FRENCH POLYNESIA	PF

deliveryCompanyName

Path: customer.shippingDetails.deliveryCompanyName

Name of the delivery company.

Format

district

Path: customer.shippingDetails.district

District of the billing address.

Format

firstName

Path: customer.shippingDetails.firstName

First name of the recipient.

Format

identityCode

Path: customer.shippingDetails.identityCode

National identifier. Allows to identify each citizen within a country.

Format

lastName

Path: customer.shippingDetails.lastName

Buyer's last name.

Format

legalName

Path: customer.shippingDetails.legalName

Legal name in case of shipping to a company.

Format

phoneNumber

Path: customer.shippingDetails.phoneNumber

Buyer's phone number.

Accepts all formats:

Examples:

0123456789
+33123456789
0033123456789
(00.571) 638.14.00
40 41 42 42

Format

shippingMethod

Path: customer.shippingDetails.shippingMethod

Shipping mode.

Format

Possible values

value	Description
RECLAIM_IN_SHOP	Item pickup at the shop.
RELAY_POINT	Use of a third-party pickup network (Kiala, Alveol, etc.).
RECLAIM_IN_STATION	Pickup at an airport, a train station or a travel agency.
PACKAGE_DELIVERY_COMPANY	Shipping by the transporter (Colissimo, UPS, etc.).
ETICKET	Issue of an electronic ticket, online download of the product.
CARD_HOLDER_ADDRESS	Delivery to the buyer. Reserved for future use.
VERIFIED_ADDRESS	Delivery to a verified address.Reserved for future use.
NOT_VERIFIED_ADDRESS	Delivery to a non-verified address.Reserved for future use.
SHIP_TO_STORE	In-store pickup.Reserved for future use.
DIGITAL_GOOD	Digital delivery.Reserved for future use.
ETRAVEL_OR_ETICKET	E-ticket.Reserved for future use.
OTHER	Other: Reserved for future use.
PICKUP_POINT	Pickup point delivery.Reserved for future use.
AUTOMATED_PICKUP_POINT	Pickup at an automatic pickup point.Reserved for future use.

shippingSpeed

Path: customer.shippingDetails.shippingSpeed

Shipping delay.

Format

Possible values

Examples of possible values:

value	Description
STANDARD	Standard shipping.
EXPRESS	Express shipping (in less than 24h).
PRIORITY	Priority shipping (Click & Collect).

state

Path: customer.shippingDetails.state

Region of the billing address.

Format

streetNumber

Path: customer.shippingDetails.streetNumber

Street number of the delivery address.

Accepted characters:

Alphabetical characters (from "A" to "Z" and from "a" to "z")
Space

Format

zipCode

Path: customer.shippingDetails.zipCode

Zip code of the billing address.

Format

insuranceAmount

Path: customer.shoppingCart.insuranceAmount

Insurance amount for the entire order, expressed in the smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

shippingAmount

Path: customer.shoppingCart.shippingAmount

Amount of delivery fees for the entire order, expressed in its smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

taxAmount

Path: customer.shoppingCart.taxAmount

Amount of taxes for the entire order expressed in the smallest monetary unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

cartItemInfo

Path: customer.shoppingCart.cartItemInfo

cardItemInfo is a list that contains Customer/ShoppingCartItemInfo objects.

It allows you to describe each item in the cart.

Format

productAmount

Path: customer.shoppingCart.cartItemInfo.productAmount

Amount of the product expressed in the smallest currency unit (cent for euro).

Example: 30050 for EUR 300.50.

Format

productLabel

Path: customer.shoppingCart.cartItemInfo.productLabel

Product name.

Format

productQty

Path: customer.shoppingCart.cartItemInfo.productQty

Product quantity.

Format

productRef

Path: customer.shoppingCart.cartItemInfo.productRef

Product reference.

Format

productType

Path: customer.shoppingCart.cartItemInfo.productType

Product type.

Possible values

value	Description
FOOD_AND_GROCERY	Food and grocery
AUTOMOTIVE	Cars / Moto
ENTERTAINMENT	Entertainment / Culture
HOME_AND_GARDEN	Home and gardening
HOME_APPLIANCE	Household appliances
AUCTION_AND_GROUP_BUYING	Auctions and group purchasing
FLOWERS_AND_GIFTS	Flowers and presents
COMPUTER_AND_SOFTWARE	Computers and software
HEALTH_AND_BEAUTY	Health and beauty
SERVICE_FOR_INDIVIDUAL	Services for individuals
SERVICE_FOR_BUSINESS	Services for companies
SPORTS	Sports
CLOTHING_AND_ACCESSORIES	Clothes and accessories
TRAVEL	Travel
HOME_AUDIO_PHOTO_VIDEO	Sound, image and video
TELEPHONY	Telephony

Format

productVat

Path: customer.shoppingCart.cartItemInfo.productVat

Product type.

Tax fee amount (expressed in the smallest currency unit).

Possible values

value	Description
integer	Transaction amount. Its value must be a positive integer (e.g.: 1234 for 12.34 EUR).
Decimal number, lower than 100	Percentage applied to the amount. Examples: 20.0 or 19.6532

To display a percentage applied to the payment amount for the product in question, the value should have maximum 4 digits after the decimal point. The decimal separator is mandatory for displaying a percentage. The decimal separator is represented by the "." symbol.

Format

paymentMethodToken

Token associated with a payment method.

Format

strongAuthentication

strongAuthentication is used to indicate the merchant preference during buyer authentication.

Without cardholder interaction ( frictionless ).
With cardholder interaction (strong authentication or challenge ).
No merchant preference.

Strong authentication is required when registering a card. Use the formAction field with the following values:

REGISTER_PAY : to make a payment while registering the payment method.
ASK_REGISTER_PAY : to make a payment and request registration of the payment method.
CUSTOMER_WALLET : to register the payment method.

In this case, the strongAuthentication field automatically takes the CHALLENGE_MANDATE value.

Use cases	Possible values
CHALLENGE : With cardholder interaction	ENABLED : Deprecated value
	CHALLENGE_REQUESTED : Allows to request strong authentication for the transaction.
	CHALLENGE_MANDATE : Allows to request strong authentication for the transaction for regulatory reasons.
FRICTIONLESSWithout cardholder interaction “Frictionless 3DS2” option mandatory	DISABLED: Allows you to requestan exemptionfrom strong authentication. Low value transaction LRM (Low Risk Merchant) If you do not have the “Frictionless 3DS” option, the choice of preference is delegated to the card issuer (No Preference). If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.
No merchant preference	NO_PREFERENCE : Allows to indicate to the DS that the merchant does not have a preference. If the issuer decides to perform an authentication without interaction (frictionless), the payment will be guaranteed.
No merchant preference	AUTO : The choice of preference is delegated to the card issuer (No Preference).

Table of exemptions (DISABLED value)

exemption	Description
Low value transaction	For payments in EUR, you can requestan exemptionTo strong authentication: If the transaction amount is less than €30 and within the limit of either 5 consecutive operations or a total amount of less than €100. If the amount is higher than €30, the value transmitted by the merchant is ignored and the choice of the preference is delegated to the card issuer (No Preference). For payments made in a currency other than euro, a frictionless request is sent to the issuer.If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.
LRM (Low Risk Merchant)	CB's LRM (Low Risk Merchant) program aims to meet the expectations of merchants with very low risk and high volume (120,000 CB transactions / year). Vous pouvez demander une exemption à l'authentification forte : Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles. Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions : Avoir un contrat CB. Etre éligible à la TRA acquéreur. Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme. If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder. To benefit from CB's LRM program, you must contact your customer service to obtain explicit agreement.

exemption

Description

Low value transaction

For payments in EUR, you can requestan exemptionTo strong authentication:

If the transaction amount is less than €30 and within the limit of either 5 consecutive operations or a total amount of less than €100.
If the amount is higher than €30, the value transmitted by the merchant is ignored and the choice of the preference is delegated to the card issuer (No Preference).

For payments made in a currency other than euro, a frictionless request is sent to the issuer.If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.

LRM (Low Risk Merchant)

CB's LRM (Low Risk Merchant) program aims to meet the expectations of merchants with very low risk and high volume (120,000 CB transactions / year).

Vous pouvez demander une exemption à l'authentification forte :

Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles.
Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions :
- Avoir un contrat CB.
- Etre éligible à la TRA acquéreur.
- Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme.

If the request for frictionless is accepted, the transaction does not benefit from the liability shift in case of a dispute by the cardholder.

Format

paymentMethods

List of payment methods to be offered to the buyer.

Example: ["VISA", "MASTERCARD"]

If this list contains only one payment method, the detail entry page for this payment method will directly appear. Otherwise the payment method selection page will be presented.

If this parameter is empty (recommended), the eligible payment methods (currencies, technical constraints, etc.) associated with the shop will be presented.

Format

acquirerTransientData

Allows to transmit information specific to certain acquirers.

Use with Conecs

Optional field that allows to transmit the amount of items eligible for payment with the CONECS meal voucher card.

If the field is not transmitted, the whole amount will be considered eligible for payment by meal vouchers, including any delivery fees included in the order amount.

Example for an eligible amount of €17.25:

Example: .

{"CONECS":{"eligibleAmount":"1725"}}

Restrict the accepted BIN codes

To limit the accepted payment cards based on their BIN code, the expected format is:

{"MULTI":{"bins": ["bin1","bin2","bin3"]}}

NB : Supports 6-digit BIN codes or 8-digit BIN codes.

Example: .
code BIN à6 digits: 4012 34XX XXXX XXXX;
code BIN à8 digit: 4000 1234 XXXX XXXX.

Format

manualValidation

Path: transactionOptions.cardOptions.manualValidation

Transaction validation mode.

Format

Possible values

. The possible values are:

value	Description
NO	Automatic validation by the payment gateway.
YES	Manual validation by the Merchant.
null	Default configuration of the selected shop (configurable in the Merchant Back Office).

captureDelay

Path: transactionOptions.cardOptions.captureDelay

Delay to be applied to the capture date.

Description

Indicates the delay (in days) before the capture.

If this parameter is not passed, then the default value set in the Merchant Back Office will be used.

It can be set in the Merchant Back Office by all authorized persons.

If the capture delay is higher than 365 days in the payment request, it will be automatically reset to 365 days.

Format

installmentNumber

Path: transactionOptions.cardOptions.installmentNumber

Number of installments. Warning: This field is only applicable to Brazil

Format

firstAmount

Path: transactionOptions.installmentOptions.firstAmount

First payment amount in N installments.

Format

count

Path: transactionOptions.installmentOptions.count

Number of payment due dates in N installments.

Format

period

Path: transactionOptions.installmentOptions.period

Interval (days) of payment in N installments.

Format

amount

Path: transactionOptions.installmentOptions.schedules.amount

Maturity amount.

Format

date

Path: transactionOptions.installmentOptions.schedules.date

Due date.

Format

companyType

Path: subMerchantDetails.companyType

Company type of the sub-merchant.Transmitted by the payment facilitator.

Different rules may apply depending on the acquirer. This field is often used for specifying the type of Legal Number of the buyer.

Format

legalNumber

Path: subMerchantDetails.legalNumber

Legal number of sub-merchant according to field companyType . Transmitted by the payment facilitator.

Format

name

Path: subMerchantDetails.name

Business name of the sub-merchant.Transmitted by the payment facilitator.

Format

url

Path: subMerchantDetails.url

URL of the sub-merchant.Transmitted by the payment facilitator.

Format

phoneNumber

Path: subMerchantDetails.phoneNumber

Telephone number of the sub-merchant.Transmitted by the payment facilitator.

Format

address1

Path: subMerchantDetails.address1

Address of the sub-merchant.Transmitted by the payment facilitator.

Format

address2

Path: subMerchantDetails.address2

Addition of the sub-merchant's address. Transmitted by the payment facilitator.

Format

zip

Path: subMerchantDetails.zip

Zip code of the sub-merchant.Transmitted by the payment facilitator.

Format

city

Path: subMerchantDetails.city

City of the sub-merchant.Transmitted by the payment facilitator.

Format

country

Path: subMerchantDetails.country

Country code of the sub-merchant address (ISO 3166 alpha-2 standard). Transmitted by the payment facilitator.

Format

mcc

Path: subMerchantDetails.mcc

MCC code of the sub-merchant.Transmitted by the payment facilitator.

Format

mid

Path: subMerchantDetails.mid

Contract number (MID) of the sub-merchant.Transmitted by the payment facilitator.

Format

softDescriptor

Path: subMerchantDetails.softDescriptor

Label (Soft-descriptor) of the sub-merchant that appears on the buyer's bank statement. Transmitted by the payment facilitator.

Format

state

Path: subMerchantDetails.state

Region of the sub-merchant's address. Transmitted by the payment facilitator.

Format

facilitatorId

Path: subMerchantDetails.facilitatorId

Payment Facilitator ID. Transmitted by the payment facilitator.

Format

Response reference

Response	Context
PaymentOrder	Object containing the details of the updated payment order.

Categories

Tags

PaymentOrder/Update web service

Input parameters

paymentOrderId

Format

amount

Format

currency

Format

Possible values

orderId

Format

channelType

Path: channelOptions.channelType

Format

Possible values

bcc

Path: channelOptions.mailOptions.bcc

Format

body

Path: channelOptions.mailOptions.body

Format

Contents

recipient

Path: channelOptions.mailOptions.recipient

Format

subject

Path: channelOptions.mailOptions.subject

Format

Contents

template

Path: channelOptions.mailOptions.template

Format

message

Path: channelOptions.smsOptions.message

Format

phoneNumber

Path: channelOptions.smsOptions.phoneNumber

Format

phoneNumber

Path: channelOptions.whatsAppOptions.phoneNumber

Format

ivrPaymentOrderId

Path: channelOptions.ivrOptions.ivrPaymentOrderId

Format

formAction

Possible values

Format

dataCollectionForm

Format

expirationDate

Format

locale

Format

merchantComment

Format

paymentReceiptEmail

Format

taxAmount

Format

taxRate

Format

allowDCFAmountUpdate

Format

Possible values

Format

metadata

Example of a call

Format

returnMode

Possible values

Format

returnUrl

Format

cancelUrl

Format

successUrl

Format

refusedUrl