Highlights

Home
Getting started
- About Connect
- Basic principles
- Integration methods
- Operating models
  - Full service
  - Gateway service
- Go live
Payment methods
- By country
- By payment product
- Beta programs
Accepting payments
- Payment scenarios
  - One-off payment
  - Installments
  - Single-click payments
  - Recurring & Subscription
  - Merchant initiated transaction
  - Authorization reversal
  - Tokenization
    - Card on file
    - Account Updater batch
    - Account Updater token
    - Direct Debit mandate
- Compliance
  - Privacy and Data Protection
  - PCI DSS
  - PSD2
- Handling multiple currencies
- Fraud management
  - Address verification (AVS)
  - Bank account validation
  - Card-not-present fraud
  - Card verification value (CVV)
  - Device fingerprint
  - Fraud risk triggers
  - Fraud status codes
  - Test scenarios
  - --- Line separator ---
  - ACI Fraud Prevention
  - Microsoft Dynamics 365
  - 3D Secure
    - Dynamic 3D secure
    - 3D secure version 2
    - 2-step 3D secure
- Mobile
  - Top 10 tips
  - Mobile payments
- Industries
  - Industries
  - Digital
  - Gaming
  - Retail
  - Travel
After the payment
- Refunds
- Chargeback handling
  - Dispute
  - Soft descriptor
  - Return policy
Developer tools
- Two-factor authentication
- API Explorer
- Ordering of payment products
- Configuration center
- Hosted payment pages
  - Shopping cart
  - Subscription details
- SDKs
  - Mobile and browser SDKs
    - Android SDK
    - iOS SDK
    - Swift SDK
    - JavaScript browser SDK
    - Flutter mobile SDK
  - Server SDKs
    - Java SDK
    - PHP SDK
    - Node.js SDK
    - .NET SDK
    - Python SDK
    - Ruby SDK
    - Go SDK
- Full API references
  - Server API
  - Client API
- API versioning
- Test cases
- Error handling
  - Response codes
  - Error codes
  - Managing exceptions
  - Idempotent requests
- Webhooks
  - Event types
  - Event structure
- Plugins
  - Magento 2
    - Overview
    - Payment products
    - Requirements
    - Installation
    - Configuration
    - Workflow tips
    - Previous versions
    - Troubleshooting
  - VTEX
Reporting
- Secure file transfer
Trending
- Trending
Support
- Release Notes
  - Highlights
  - REST API
  - MyCheckout Hosted Pages
  - Webhooks
  - Server & Client SDKs
  - Other
- Old release notes
  - Overview
- FAQ
- Contact
API Reference
- Sandbox
- Configuration Center
  Explore our sandbox to discover the possibilities of our payment solutions.
  Sign up for sandbox
- Pre-production
- Configuration Center
- Payment Console
- Production
- Configuration Center
- Payment Console
- Insights
Switch color mode Theme

Results for

Results for Searching

2406.00.00

June, 2024

Other

Added

In the Configuration Center you can now adjust the order of payment products. This order is shown to your consumers on the payment product selection page of the MyCheckout hosted payment pages and is also returned in the displayOrder property of the GET payment product(s) API call.

2405.00.00

May, 2024

REST API

Added

The property payment.paymentOutput.cardPaymentMethodSpecificOutput.networkTokenUsed has been added to the payment response to indicate if a network token was during the payment.
A new property order.shipping.shippedFromZip is added to the Create Payment and Create Hosted Checkout request.
A new property order.shoppingCart.items.orderLineDetails.naicsCommodityCode is added to the Create Payment and Create Hosted Checkout request.

Fixed

Resolved an issue where the getProduct and getProducts API calls did not return false for the property canBeIframed for paymentProductId 865, and 8590 - 8597.

MyCheckout Hosted Payment Pages

Fixed

Resolved an issue that caused the dropdowns in the header (e.g. currency selection) to become unresponsive for a subset of ~merchantId~s with specific configuration.

Other

Fixed

Fixed an issue that prevented users from uploading Apple Pay certificates. Users can now successfully upload their Apple Pay certificate without any errors.

Webhooks

Added

The property payment.paymentOutput.cardPaymentMethodSpecificOutput.networkTokenUsed has been added to the payment response to indicate if a network token was during the payment.

2404.00.00

April, 2024

REST API

Changed

The property order.customer.fiscalNumber can now dynamically be made optional on the Create Payment API with a feature toggle.
Fixed an issue for which now one error will be returned in the response in case an invalid Brazilian fiscal number is provided in the request.
Adjusted the displayOrder returned in GET /v1/{merchantId}/products and GET /v1/{merchantId}/products/{paymentProductId} API calls for countryCodes: AR, AU, BR, CA, CN, FR, DE, IN, JP, MX, NL, KR, TR, UK, US to give products a higher priority depending on the country.

MyCheckout Hosted Payment Pages

Changed

The payment product ordering for the payment product selection page is changed for the default order and for the following countries: Argentina, Australia, Brazil, Canada, France, Germany, India, Japan, Mexico, Netherlands, Mexico, South Korea, Turkey, Unites States, United Kingdom.

Webhooks

Fixed

The payment status CAPTURED is now returned if a payment webhook event is sent with a final partial capture.

Other

Changed

Replaced references to "Ingenico" with "Worldline" in request and response examples.

2403.00.00

March, 2024

REST API

Added

The properties city, houseNumber, street, and zip in the property order.additionalInput.accountFundingRecipent.address. are now made optional on the hosted checkout and create payment request.

Fixed

Fixed an issue with recurring payments for which cvv is not present.
Proper 400 error message will be returned when merchantId is not provided in the request.

2402.00.00

February, 2024

REST API

Added

Added isInstallments query parameter for the Get Payment Product(s) and Get Payment Product Group(s) endpoints.

Changed

When creating a payment for Brazil using a order.customer.fiscalNumber from a legal entity, the property order.customer.personalInformation is no longer required.
Improved the validation on Brazilian fiscal numbers.

MyCheckout Hosted Payment Pages

Fixed

The configured business name will now be displayed in the Apple Pay payment sheet unless provided in the hosted checkout request.

Other

Changed

Pop-up texts for Payment Products Ordering page.

2401.00.00

January, 2024

REST API

Added

It is now possible to create UCOF payments by presenting card details.
New funding types fundingGiftCardForPersonalUse and fundingGiftCardForSomeoneElse added to order.additionalInput.typeInformation.fundingType.
New account number type giftCard added to order.additionalInput.accountFundingRecipient.accountNumberType.
New funding type storedValueDigitalWallet added to order.additionalInput.typeInformation.fundingType.

Changed

The payment product Pix (ID 6105) no longer requires the properties street, houseNumber, city, stateCode, and zipCode to be present in the property order.customer.billingAddress.
The order.customer.device object is now made optional on the hosted checkout request.

Fixed

Modified the API documentation to change the title from Get installment info to Get installment information.
The payment product Pix (ID 6105) no longer requires the property phoneNumber or mobilePhoneNumber to be present in the property order.customer.contactDetails.
The payment products MercadoPago (ID 6106) and PicPay (ID 6107) no longer require the properties order.customer.contactDetails.phoneNumber or order.customer.contactDetails.mobilePhoneNumber.
Required fields for OXXO payment product in Mexico changed to only firstName, lastName, and email.
Required fields for OXXO Pay payment product in Mexico changed to only firstName, lastName, and email.
Required fields for PicPay payment product in Brazil changed to only firstName, lastName, email, and iscalNumber.
Required fields for Mercado Pago payment product in Argentina, Brazil and Mexico changed to only firstName, lastName, and email with fiscalNumber as an additional requirement for Argentina and Brazil.
Resolved a problem where the HTTP status code 404 was incorrectly returned instead of 400 when the error code 'PARAMETERNOTFOUNDINREQUEST.
The original error message from WL Online Payment Platform is now returned in the error message.
The correct error is now returned if the property order.customer.fiscalNumber is invalid when creating a payment.

Other

Added

Updated the webhooks page to include a note that there can be a delay of up to 10 minutes from the time an endpoint is added until it becomes active.

Fixed

Fixed an issue where users were unable to download CSRs on the Apple Pay page.
Fixed the "Contact us" link on the dashboard page and a few existing typos.

2312.00.00

December, 2023

REST API

Added:

Added a new property cardPaymentMethodSpecificInput.acquirerPromotionCode to POST/v1/{merchantId}/payments and POST/v1/{merchantId}/hostedcheckouts API calls.

Changed:

Included new endpoint URLs and description text.

MyCheckout Hosted Payment Pages

Fixed:

Total amount for the payment page is used in MyCheckout hosted payment page editor.
The fiscalNumber property is now made visible on the MyCheckout hosted payment pages for OXXO Pay and Mercado Pago.

2311.00.00

November, 2023

REST API

Added:

The property fraudResults.microsoftFraudProtection has been added to the payment response.

The property isAuthenticationSupported has been added to the PaymentProduct object. This property indicates if the payment product supports 3D Secure.

Changed:

Adjusted the displayOrder returned in GET /v1/{merchantId}/products and GET /v1/{merchantId}/products/{paymentProductId} API calls for countryCode to give debit products a higher priority.
The property cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceInfo is removed.

Fixed:

If a card is co-branded, we now return the correct payment product ID.

MyCheckout Hosted Payment Pages

Added:

Added the option to customize the subscription details for the MyCheckout hosted payment pages.

Changed:

The payment product ordering for the payment product selection page is changed for Finland as new Finland regulations require a non-credit product to be shown as the first payment product to a consumer.

2310.00.00

October, 2023

REST API

Added

fundingType property to order.additionalInput.typeInformation
order.additionaInput.accountFundingRecipient property with name, address, accountNumber, accountNumberType, dateOfBirth and partialPan
firstName and surname properties to order.additionaInput.accountFundingRecipient.name
additionalInfo, city, stateCode, state, countryCode, houseNumber, street and zip properties to order.additionalInput.accountFundingRecipient.address
order.customer.personalInformation.identification property with idType, idValue and idIssuingCountry
isCompany property to order.customer
The property redirectPaymentMethodSpecificInput.paymentProduct809SpecificInput.issuerId is no longer required when the merchant is configured to use iDEAL 2.0
The complete payment endpoint can now be used for completing 3D Secure payments.
Mapped error code 33000833 to HTTP status 400 INVALID_VALUE.
canBeIframed flag for PP 843 (gateway & domain) is added

Fixed

Fixed validation of the following fields for the hosted checkout request:

fraudFields.customerIpAddress
fraudFields.orderTimezone
merchant.websiteUrl
order.customer.device.ipAddress
order.customer.device.locale
order.customer.device.timeZoneOffsetUTCMinutes
order.customer.device.userAgent
order.shoppingCart.items.invoiceData.description
order.shoppingCart.items.orderLineDetails.productName
The merchant property is now made visible on the CreateHostedCheckoutRequest.
The property KeyValuePair.value is now returned even when the value is null.

Deprecated

Deprecated property order.additionalInput.loanRecipient with no replacement.

MyCheckout Hosted Payment Pages

Added

Added the option to customize the subscription details for the MyCheckout hosted payment pages

Fixed

Payment products where not updated when changing between different currencies.
Payment products without instructions are now not being shown in the editor.

Other

The file extension of the language packs is changed to xlsx.