agricole
Sign up

Paypal

Paypal

Intro

PayPal is a wallet which offers its consumers the option to pay online. The consumers can fund their wallet or choose to pay with their preconfigured payment method.

Our platform offers you the possibility to easily accept PayPal payments online. When your consumers choose to pay by PayPal, they are redirected to their PayPal account to confirm the order information and payment method. Next, we process the transaction through PayPal and transaction feedback is provided by PayPal. A real-time confirmation message is provided to both you and the consumer which contains the payment status.

Our platform has one of the most extensive integrations with PayPal available and is integrated to PayPal’s Express Checkout interface. You can choose between Express Checkout Shortcut (ECS) or Express Checkout Mark (ECM) as integration options.

Overview

Payment group:
Payment product id:
840
Key benefits
  • Fraud Prevention: Allows you to use user data for fraud prevention
  • Line items: Allows you to include basket items in the transaction
  • Direct sale and Authorization/Data Capture
  • Re-authorizations
  • Void authorizations
  • Refunds: Full/Partial refunds on single capture; Full refunds on multiple captures
  • Seller protection

Boarding

Countries & currencies

Supported countries

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 payment portal via our Hosted Checkout Page. Find a high level overview in the "Process flows" chapter.

Our platform allows both Express Checkout Mark and Express Checkout Shortcut mode. Depending on the mode, , differences apply:

Express Checkout Mark mode

Add the following properties to a standard CreateHostedCheckout request:

{
"order": {
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 1000
}
},
"hostedCheckoutSpecificInput": {
"returnUrl": "https://yourReturnURL.com"
},
"redirectPaymentMethodSpecificInput": {
"paymentProduct840SpecificInput": {
"isShortcut": false
},
"PaymentProductId": "840"
}
}

Express Checkout Shortcut mode

Add the following properties to a standard CreateHostedCheckout request:

{
"order": {
"amountOfMoney": {
"currencyCode": "EUR",
"amount": 1000
}
},
"hostedCheckoutSpecificInput": {
"returnUrl": "https://yourReturnURL.com"
},
"redirectPaymentMethodSpecificInput": {
"paymentProduct840SpecificInput": {
"isShortcut": true
},
"PaymentProductId": "840"
}
}
Properties Remarks

redirectPaymentMethodSpecificInput
     paymentProductId
     requiresApproval

paymentProductId: The numeric identifier of the payment method on our platform. Find this id in the "Overview" chapter. It instructs our platform to send your customers directly to the Paypal portal. If left out, our platform sends your customers to the Hosted Checkout Page instead, allowing them to choose this or any other payment method in your account

requiresApproval: Set to "false" as this payment method allows only direct sale operations

paymentProduct840SpecificInput.isShortcut

Defines whether you use Express Shortcut (true) or Checkout Markt (false)

hostedCheckoutSpecificInput.returnUrl

The URL we redirect your customers to after the payment has been finalised

Find detailed information about this object and its properties in our CreateHostedCheckoutAPI

Process flows

  1. Your customers finalise an order in your shop and select PayPal
  2. You send one of these CreateHostedCheckout requests (Express Checkout Mark or Express Checkout Shortcut) to our platform
  3. You redirect your customers via the redirectUrl 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 GetPayment or receive the result via webhooks
  7. If the transaction was successful, you can deliver the goods / services
Paypal-flow.png

Testing

Refer to our Test cases for test data and detailed instructions

Make sure to use the right endpoint and switch back to the live URL as soon as you have finished your tests

Additional information

Make sure to switch to the LIVE endpoint as soon as you have finalised your tests

Was this page helpful?

Do you have any comments?

Thank you