No results

POST/build/finalize_payment

PROD
https://xpay.nexigroup.com/api/phoenix-0.0/psp/api/v1/build/finalize_payment
TEST
https://xpaysandbox.nexigroup.com/api/phoenix-0.0/psp/api/v1/build/finalize_payment

Conclude a payment using the XPay Build solution.

PARAM HEADER
NAME DESCRIPTION FORMAT
Correlation-Id Mandatory field in UUID v4 format.
The purpose of this field is to trace the request across different systems, making debugging and request tracking easier.
 String
Format: uuid
Example: 123e4567-e89b-12d3-a456-426614174000
Language Language header parameter String
Default: ITA
X-Api-Key Authentication API Key. String
Format: uuid
Example: 625b4884-38f8-11ed-a261-0242ac120002
PARAM PATH
NAME DESCRIPTION FORMAT
No param path
PARAM QUERY
NAME DESCRIPTION FORMAT
No param query
PARAM BODY

sessionRequest

NAME DESCRIPTION FORMAT
sessionId Session identifier.
 String
Arrow RESPONSE 200
Request successfully processed The returned states can be: * PAYMENT_COMPLETE: meaning that the payment flow reached the end, either with success or failure. The operation field describes in detail the payment result. * REDIRECTED_TO_EXTERNAL_DOMAIN: it is required to perform a user authentication on an external domain. This may happen for a 3DS challenge of a card payment or for any payment performed with alternative payment methods. In all cases, the user's browser shall be redirected to the url indicated in the field 'url'. - No Header for this response
BODY
NAME DESCRIPTION FORMAT
fieldSet Object containing the iframes for choosing payment methods or for collecting card data.
 Object
fields List of fields to be rendered in the checkout page.
 Array
class Field class, possible values:
- APM
- CARD
 String
Example: cardData
id Field identifier.
 String
Example: cardholderName
src Iframe URL dedicated to the payment method.
 String
Example: https:///field.html?id=CARDHOLDER_NAME&sid=052211e8-54c8-4e0a-8402-e10bcb8ff264
type Type of field, possible values:
- ACTION: field that requires an action by the cardholder on the iframe, in this case the click on the component.
 String
Example: text
securityToken Security token used by the merchant to validate the source of the notification. String
Example: f3b2c1d4e5a6b7c8d9e0f1a2b3c4d5e6
sessionId Session identifier.
 String
Example: sessionId
sriHash SRI hash for the XPay Build JavaScript SDK.
 String
state It indicates the flow adopted for the ongoing payment. The possible values are:
- PAYMENT_METHOD_SELECTION
- CARD_DATA_COLLECTION
- READY_FOR_PAYMENT
- REDIRECTED_TO_EXTERNAL_DOMAIN
- PAYMENT_COMPLETE
 String
Example: CARD_DATA_COLLECTION
url Url for the redirection to the external domain.
This parameter is returned if the "state" parameter is set to "REDIRECTED_TO_EXTERNAL_DOMAIN".
 String
Example: https://anyurl.it
warnings List of warnings related to the payment operation.
 Array
code Warning code. String
Example: TRA001
description Warning description. String
Example: 3DS warning
operation Object containing the details of a payment operation.
 Object
additionalData Map of additional fields specific to the chosen payment method
 Object
cancelledOperationId Operation id to be undone
 String
channel It indicates the originating channel:
* ECOMMERCE - cardholder initiated operation through an online channel.
* POS - cardholder initiated operation through a physical POS.
* BACKOFFICE - merchant initiated operation. It includes post operations and MIT.
 String
Example: ECOMMERCE
customerInfo Object containing the customer detail. Sending the content of this object increases the security level of the transaction, thus increasing the probability that two-factor authentication will not be requested in the payment.
 Object
billingAddress Object containing the detail of the customer's address.
 Object
additionalInfo Additional info of address, for example floor.
Recommended maximum length: 50 characters.
 String
Example: Quinto Piano, Scala B
city City.
Recommended maximum length: 40 characters.
 String
Example: Bologna
country State in ISO 3166-1 alpha-3 code.
Recommended maximum length: 3 characters.
 String
Example: ITA
name Name and surname.
Recommended maximum length: 50 characters.
 String
Example: Mario Rossi
postCode Postal code.
Recommended maximum length: 16 characters.
 String
Example: 40124
province Code of province.
Recommended maximum length: 3 characters.
 String
Example: BO
street Full address.
Recommended maximum length: 50 characters.
 String
Example: Piazza Maggiore, 1
cardHolderAcctInfo Object containing information about the buyer's account.
 Object
chAccAgeIndicator Account age indicator on the merchant site:
01 = No account
02 = Created during this transaction
03 = Created in the last 30 days
04 = Created between 30 and 60 days ago
05 = Created before 60 days ago
 String
Example: 01
chAccChangeDate Date of the last variation of the account on the merchant's website, including Billing or Shipping address, new payment account, or new user(s) added.
 String
Example: 2019-02-11T00:00:00.000+0000
chAccChangeIndicator Elapsed time since the last change to the buyer's account information on the merchant site, including Billing or Shipping address, new payment account, or new user(s) added.
01 = Created during this transaction
02 = Created in the last 30 days
03 = Created between 30 and 60 days ago
04 = Created before 60 days ago
 String
Example: 01
chAccDate Date of activation of the account on the merchant's website.
 String
Example: 2019-02-11T00:00:00.000+0000
chAccPwChangeDate Date of last account password change (including password reset).
 String
Example: 2019-02-11T00:00:00.000+0000
chAccPwChangeIndicator Time elapsed since the buyer's account performed a password change or account recovery:
01 = No account
02 = Created during this transaction
03 = In the last 30 days
04 = Between 30 and 60 days ago
05 = Before 60 days ago
 String
Example: 01
destinationAddressUsageDate Date of last use of this delivery address.
 String
Example: 2019-02-11T00:00:00.000+0000
destinationAddressUsageIndicator Indicates when the shipping address used for this transaction was used for the first time:
01 = Created during this transaction
02 = Created in the last 30 days
03 = Created between 30 and 60 days ago
04 = Created before 60 days ago
 String
Example: 01
destinationNameIndicator Indicates if the name associated with the account matches the name listed for shipping:
01 = Account name identical to the shipping address name.
02 = Different account name from the shipping address name
 String
Example: 01
nbPurchaseAccount Number of purchases of this account in the last 6 months.
 Integer
Example: 0
paymentAccAgeDate Payment account activation date.
 String
Example: 2019-02-11T00:00:00.000+0000
paymentAccIndicator Indicates when the buyer has entered the Payment account on the merchant's site:
01 = No account
02 = created during this transaction
03 = Created in the last 30 days
04 = Created between 30 and 60 days ago
05 = Created before 60 days ago
 String
Example: 0
provisionAttemptsDay Number of attempts to add a new card in the last 24 hours.
 Integer
Example: 0
suspiciousAccActivity Indicates whether the merchant has detected suspicious activity (including previous fraud) on the buyer's account:
01 = No suspicious activity verified.
02 = Suspicious activity detected
 String
Example: 01
txnActivityDay Number of transactions (successful and abandoned) for this account in the previous 24 hours.
 Integer
Example: 0
txnActivityYear Number of transactions (successful and abandoned) for this account in the previous year.
 Integer
Example: 0
cardHolderEmail Email of the cardholder.
Recommended maximum length: 255 characters.
 String
Example: mauro.morandi@nexi.it
cardHolderName Name and surname of the cardholder.
Recommended maximum length: 255 characters.
 String
Example: Mauro Morandi
homePhone Home phone number provided by the Cardholder.
Recommended maximum length: 18 characters.
 String
Example: 391231234567
merchantRiskIndicator Object containing information relating to the purchase made.
 Object
deliveryEmail In case of purchase of virtual/digital products: email address to which the product is sent.
 String
Example: john.doe@email.com
deliveryTimeframe Indicator on the delivery period of the goods:
01 = Immediate Delivery (virtual/digital products).
02 = Same day delivery.
03 = Night delivery.
04 = Delivery in two or more days
 String
Example: 01
giftCardAmount Object containing the total amount and currency of the prepaid or gift card(s) purchased.
 Object
currency For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.
EMVCO: giftCardCurr
 String
Example: EUR
value For prepaid or gift card purchase, the purchase amount total
of prepaid or gift card(s) in major units (for example, USD 123.45 is 123).
EMVCO: giftCardAmount
 String
Max. length: 18
Example: 100
giftCardCount Total number of individual prepaid or gift cards/codes purchased.
 Integer
Example: 0
preOrderDate For a pre-ordered purchase, the expected date that the merchandise will be available.
 String
Example: 2019-02-11T00:00:00.000+0000
preOrderPurchaseIndicator Indicates whether buyer is placing an order for merchandise with a future availability:
01 = Goods available.
02 = Future availability.
 String
Example: 01
reorderItemsIndicator Indicates whether the cardholder is reordering previously purchased merchandise:
01 = First order.
02 = Goods already purchased previously.
 String
Example: 01
shipIndicator Indicator on the type of delivery:
01 = Shipping to the billing address.
02 = Shipping to another address verified by the merchant.
03 = Delivery to a different address than the billing.
04 = Shipment or collection to the store (the address of the store must be indicated in the "destinationAddress" object).
05 = Virtual/digital goods, including online services, electronic gift certificates, recovery codes.
06 = Travel and event tickets (not sent).
07 = Other: for example games, digital services not sent, electronic media subscriptions
 String
Example: 01
mobilePhone Mobile phone.
Recommended maximum length: 15 characters.
 String
Example: 3280987654
mobilePhoneCountryCode Prefix of the mobile phone.
Recommended maximum length: 4 characters.
 String
Example: +39
recontactConsent In certain scenarios, it is possible to collect the payer's consent to be recontacted by the merchant.
This field indicates whether the payer has given such consent.
 Boolean
shippingAddress Object containing the detail of the customer's address.
 Object
additionalInfo Additional info of address, for example floor.
Recommended maximum length: 50 characters.
 String
Example: Quinto Piano, Scala B
city City.
Recommended maximum length: 40 characters.
 String
Example: Bologna
country State in ISO 3166-1 alpha-3 code.
Recommended maximum length: 3 characters.
 String
Example: ITA
name Name and surname.
Recommended maximum length: 50 characters.
 String
Example: Mario Rossi
postCode Postal code.
Recommended maximum length: 16 characters.
 String
Example: 40124
province Code of province.
Recommended maximum length: 3 characters.
 String
Example: BO
street Full address.
Recommended maximum length: 50 characters.
 String
Example: Piazza Maggiore, 1
tin Tax Identification Number is collected in certain scenarios, such as donations, to comply with tax regulations. It is an identifier used in many countries for tax purposes.
 String
Max. length: 32
Example: 12345678901
workPhone Work phone number provided by the Cardholder.
Recommended maximum length: 18 characters.
 String
Example: 391231234567
omnichannelId Omnichannel identifier. It is used to correlate the same operation across different channels.
 String
operationAmount Operation amount in the payment currency
 String
Example: 3545
operationCurrency Payment currency
 String
Example: EUR
operationId Unique identifier of the operation
 String
Example: 852525265182852619
operationResult Outcome of the operation:
* AUTHORIZED - Payment authorized
* EXECUTED - Payment confirmed, verification successfully executed
* DECLINED - Declined by the Issuer during the authorization phase
* DENIED_BY_RISK - Negative outcome of the transaction risk analysis
* THREEDS_VALIDATED - 3DS authentication OK or 3DS skipped (non-secure payment)
* THREEDS_FAILED - cancellation or authentication failure during 3DS
* PENDING - Payment ongoing. Follow up notifications are expected
* CANCELED - Canceled by the cardholder
* VOIDED - Online reversal of the full authorized amount
* REFUNDED - Full or partial amount refunded
* FAILED - Payment failed due to technical reasons
 String
Example: AUTHORIZED
operationTime Operation time in ISO 8601 format
 String
operationType It indicates the purpose of the request:
- AUTHORIZATION - payment authorization.
- CAPTURE - capture of the authorized amount.
- VOID - reversal of an authorization.
- REFUND - refund of a captured amount.
- CANCEL - the rollback of an capture, refund.
- CARD_VERIFICATION - verify operation, without any charge, with the sole purpose of confirming the validity of the card data entered by the customer.
- NOSHOW - noshow operation (reserved for Disputeless service).
- INCREMENTAL - incremental operation (reserved for Disputeless service).
- DELAY_CHARGE - delay charge operation (reserved for the Disputeless service).
 String
Example: CAPTURE
orderId Merchant order identifier, unique in the merchant domain.
The maximum length is 27 characters. To comply with payment circuit specifications, it is strongly recommended to use an orderId of up to 18 characters.
A good uniqueness strategy is to combine a stable merchant or channel prefix with a monotonic sequence, timestamp, or platform order reference, avoiding reuse for different payments.
 String
Max. length: 27
Example: btid2384983
paymentCircuit One of the payment circuit values returned by the GET payment_methods web service.
The list may include (but not limited to) VISA, MC, AMEX, DINERS, GOOGLE_PAY, APPLE_PAY, PAYPAL, BANCONTACT, BANCOMAT_PAY, MYBANK, PIS, AMAZON_PAY, ALIPAY.
 String
Example: VISA
paymentEndToEndId Identifier defined by the circuit to uniquely identify the transaction.
Required for circuit reconciliation purposes.
 String
Min. length: 18
Max. length: 35
Example: e723hedsdew12345678
paymentInstrumentInfo Payment instrument information
 String
Example: ***6152
paymentLinkId PayByLink id used for correlating this operation with the original link.
 String
Example: 234244353
paymentMethod * CARD - Any card circuit
* APM - Alternative payment method
 String
Example: CARD
warnings List of warnings related to the operation.
 Array
code Warning code. String
Example: TRA001
description Warning description. String
Example: 3DS warning
state It indicates the flow adopted for the ongoing payment. The possible values are:
- PAYMENT_METHOD_SELECTION
- CARD_DATA_COLLECTION
- READY_FOR_PAYMENT
- REDIRECTED_TO_EXTERNAL_DOMAIN
- PAYMENT_COMPLETE
 String
Example: CARD_DATA_COLLECTION
url Address for 3D Secure authentication. This parameter is returned if the "state" parameter is set to "REDIRECTED_TO_EXTERNAL_DOMAIN".
 String
Example: https://{3DS-Url}
Arrow RESPONSE 201
Created - No Header and Body for this response
Arrow RESPONSE 400
Invalid request data - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes.
 Array
code Error code.
 String
Example: GW0001
description Error description.
 String
Example: Invalid merchant URL
Arrow RESPONSE 401
Unauthorized - No Header and Body for this response
Arrow RESPONSE 403
Forbidden - No Header and Body for this response
Arrow RESPONSE 404
Not Found - No Header and Body for this response
Arrow RESPONSE 500
Internal Server Error - No Header for this response
BODY
NAME DESCRIPTION FORMAT
errors Array containing the errors list. The possible values are shown in the table Error codes.
 Array
code Error code.
 String
Example: GW0001
description Error description.
 String
Example: Invalid merchant URL