Paypal

Countries & currencies

Supported countries

• Afghanistan
• Albania
• Algeria
• American Samoa
• Andorra
• Angola
• Anguilla
• Antigua and Barbuda
• Argentina
• Armenia
• Aruba
• Australia
• Austria
• Azerbaijan
• Bahamas
• Bahrain
• Bangladesh
• Barbados
• Belarus
• Belgium
• Belize
• Benin
• Bermuda
• Bhutan
• Bolivia
• Bonaire, Saba and Sint Eustatius
• Bosnia and Herzegovina
• Botswana
• Brazil
• Brunei
• Bulgaria
• Burkina Faso
• Burundi
• Cambodia
• Cameroon
• Canada
• Cape Verde
• Cayman Islands
• Central African Republic
• Chad
• Chile
• China
• Colombia
• Comoros
• Congo (Democratic Republic)
• Congo (Republic)
• Cook Islands
• Costa Rica
• Croatia
• Cyprus
• Czech Republic
• Denmark
• Djibouti
• Dominican Republic
• Dominica
• Ecuador
• Egypt
• El Salvador
• Eswatini
• Equatorial Guinea
• Eritrea
• Estonia
• Ethiopia
• Falkland Islands
• Faroe Islands
• Fiji
• Finland
• France
• French Guiana
• French Polynesia
• Gabon
• Gambia
• Georgia
• Germany
• Ghana
• Gibraltar
• Greece
• Greenland
• Grenada
• Guadeloupe
• Guam
• Guatemala
• Guinea
• Haiti
• Honduras
• Hong Kong
• Hungary
• Iceland
• India
• Indonesia
• Iraq
• Ireland
• Israel
• Italy
• Ivory Coast
• Jamaica
• Japan
• Jordan
• Kazakhstan
• Kenya
• Kiribati
• Kuwait
• Kyrgyzstan
• Laos
• Latvia
• Lebanon
• Lesotho
• Liberia
• Libya
• Liechtenstein
• Lithuania
• Luxembourg
• Macao
• Macedonia
• Madagascar
• Malawi
• Malaysia
• Maldives
• Mali
• Malta
• Marshall Islands
• Martinique
• Mauritania
• Mauritius
• Mexico
• Micronesia
• Moldova
• Monaco
• Mongolia
• Montenegro
• Morocco
• Mozambique
• Myanmar
• Namibia
• Nauru
• Nepal
• Netherlands Antilles
• Netherlands
• New Caledonia
• New Zealand
• Nicaragua
• Nigeria
• Niger
• Niue
• Norfolk Island
• Northern Mariana Islands
• Norway
• Oman
• Pakistan
• Palau
• Panama
• Papua New Guinea
• Paraguay
• Peru
• Philippines
• Poland
• Portugal
• Puerto Rico
• Qatar
• Réunion
• Romania
• Russia
• Rwanda
• Saint Helena
• Saint Kitts and Nevis
• Saint Lucia
• Saint Pierre and Miquelon
• Saint Vincent and The Grenadines
• Samoa
• San Marino
• São Tomé and Príncipe
• Saudi Arabia
• Senegal
• Serbia
• Seychelles
• Sierra Leone
• Singapore
• Slovakia
• Slovenia
• Solomon Islands
• Somalia
• South Africa
• South Korea
• Spain
• Sri Lanka
• Sudan
• Suriname
• Sweden
• Switzerland
• Taiwan
• Tajikistan
• Tanzania
• Thailand
• Togo
• Tonga
• Trinidad and Tobago
• Tunisia
• Turkmenistan
• Turks and Caicos Islands
• Tuvalu
• Uganda
• Ukraine
• United Arab Emirates
• United Kingdom
• United States
• Uruguay
• Uzbekistan
• Vanuatu
• Vatican City
• Venezuela
• Vietnam
• Virgin Islands (British)
• Virgin Islands (U.S.)
• Yemen
• Zambia
• Zimbabwe

Supported currencies

• Australian dollar (AUD)
• Brazilian real (BRL)
• Canadian dollar (CAD)
• Czech koruna (CZK)
• Danish krone (DKK)
• Euro (EUR)
• Hong Kong dollar (HKD)
• Hungarian forint (HUF)
• Israeli new shekel (ILS)
• Japanese yen (JPY)
• Malaysian ringgit (MYR)
• Mexican peso (MXN)
• New Taiwan dollar (TWD)
• New Zealand dollar (NZD)
• Norwegian krone (NOK)
• Philippine peso (PHP)
• Polish zloty (PLN)
• Pound sterling (GBP)
• Russian ruble (RUB)
• Singapore dollar (SGD)
• Swedish krona/kronor (SEK)
• Swiss franc (CHF)
• Thai baht (THB)
• United States dollar (USD)

Integration

Redirect your customers to the PayPal portal via integration methods via our Hosted Checkout Page or Server-to-server. 

The PayPal Complete Payments API distinguishes between two modes, allowing you to adapt your customers' payment experience to your preference.

Depending on the flow, differences apply:

• PayPal displayed on the Hosted Checkout Page (formerly known as Express Checkout Mark)
• PayPal shortcut button on the merchant's checkout page (formerly known as Express Checkout Shortcut)

Find a high level overview in the "Process flows" chapter.

PayPal displayed on the Hosted Checkout Page

You collect your customers' shipping address before redirecting them to the Hosted Checkout Page. Your customers can choose between various payment options (Buy Now, Pay Later), dynamically based on customer eligibility and country. This optimised checkout flow is aligned with PayPal's UX best practices.

Add the following properties to a standard CreateHostedCheckout request:

{
   "hostedCheckoutSpecificInput":{
      "locale":"en_GB"
   },
   "redirectPaymentMethodSpecificInput":{
      "requiresApproval":true,
      "paymentProduct840SpecificInput":{
         "AddressSelectionAtPayPal":false
      }
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      },
      "customer":{
         "contactDetails":{
            "emailAddress":"test@worldline.com"
         }
      },
      "shipping":{
         "address":{
            "street":"Shipping Street",
            "houseNumber":"88",
            "zip":"1930",
            "city":"Brussels",
            "countryCode":"BE",
            "name":{
               "firstName":"ShipFN",
               "surname":"ShipLN"
            }
         },
         "type":"delivery",
         "shippingCost":0,
         "shippingCostTax":0
      }
   }
}

PayPal shortcut button on the merchant's checkout page

Available via both Hosted Checkout Page and Server-to-server, this mode allows you to place a PayPal button directly on your webshop's checkout page. Upon clicking the button, your customers are redirected to the PayPal portal for managing their shipping address and confirming the order.

Integrating via Server-to-server requires you to implement the PayPal JavaScript SDK to comply with PayPal's guidelines.

Add the following properties to a standard CreateHostedCheckout/CreatePayment request:

{
   "redirectPaymentMethodSpecificInput":{
      "requiresApproval":true,
      "paymentProductId":840,
      "paymentProduct840SpecificInput":{
         "AddressSelectionAtPayPal":true
      }
   },
   "order":{
      "amountOfMoney":{
         "amount":100,
         "currencyCode":"EUR"
      },
      "customer":{
         "contactDetails":{
            "emailAddress":" YourCustomer@domain.com"
         }
      }
   }
}

Process flows

Depending on the mode, differences apply:

• PayPal displayed on the Hosted Checkout Page
• PayPal shortcut button on the merchant's checkout page

PayPal displayed on the Hosted Checkout Page

1. Your customers finalise an order in your shop and select PayPal.
2. You send this CreateHostedCheckout request (including the shipping details) to our platform.) to our platform.
3. You redirect your customers via the redirectUrl to Hosted Checkout Page. They select PayPal and are redirected to the PayPal Portal. They confirm the order with their login credentials (email address and password).
4. We receive the transaction result.
5. We redirect your customer to your returnUrl.
6. You request the transaction result from our platform via GetHostedCheckout or receive the result via webhooks.
7. If the transaction was successful, you can deliver the goods / services.

PayPal shortcut button on the merchant's checkout page

1. Your customers finalise an order in your shop and select PayPal.
2. You send this CreateHostedCheckout/CreatePayment request to our platform.
3. You redirect your customers via the returnUrl(For CreateHostedCheckout requests) or merchantAction.redirectData.redirectURL (For CreatePayment requests) to the PayPal Portal. They select their shipping details and confirm the order with their login credentials (email address and password).
4. We receive the transaction result.
5. We redirect your customer to your returnUrl.
6. You request the transaction result from our platform via GetHostedCheckout/GetPaymentDetails or receive the result via webhooks.
7. If the transaction was successful, you can deliver the goods / services.

Testing

Refer to our Test cases for test data and detailed instructions.

Additional information

PayPal Vault (Recurring payments)

The PayPal Vault feature allows you to store your customers' PayPal data for future use: Recurring payments or subscriptions. 

Just like the COF framework for card payments, you need your customers' explicit consent to store and use tokens for Merchant-initiated-transactions (MIT).

Token creation (Initial transaction)

Add property redirectPaymentMethodSpecificInput.tokenize=true to either CreateHostedCheckout/CreatePayment request from the "Integration" chapter. If the transaction is successful, our platform returns a token in property redirectPaymentMethodSpecificOutput.token.

Token usage (MIT)

Add property redirectPaymentMethodSpecificInput.token with the value you have received in the initial payment response.