PayPal

PayPal
PayPal is currently in BETA.
PayPal is a popular eWallet, whereby their users are able to send and receive money using funds directly from their wallet and / or from their credit / debit card. 
Link your existing PayPal account to Judopay, to enable an easy integration of PayPal alongside other payment methods. 
Reconcile your PayPal payments within the Judopay Portal.
﻿
Integrating PayPal (BETA)
Integrate PayPal using our Web SDK.
Contact Developer Support to link your production PayPal account to your Judopay account.
Currently, you are only able to link your production PayPal account.
For more details on testing, contact Developer Support.
Prerequisites
Make sure you are using Web SDK Version 0.0.18 (or higher).
Make sure you have implemented the following prerequisites from the Web SDK integration guide:
﻿Create a paymentSession﻿﻿
﻿Add the Payment Form to your Website﻿﻿
The payment form iFrame must be loaded onto the page in order for payments to work. 
However displaying the form to the consumer is not required for this transaction type.
To hide the payment form iFrame, use: 
<div id="payment-iframe" style="position:absolute;width:0;height:0;border:0;"></div>
﻿
﻿
Step One: Display the PayPal Button
﻿
Currently /payments (immediate capture) is supported when implementing PayPal via the Web SDK.
Make sure the following parameters are the same values as those entered in Creating a paymentSession﻿ otherwise the transaction will fail:
merchantPaymentReference
merchantConsumerReference
JudoID
Currency
Amount
This is used to cross reference the validity of the transaction.
Your backend server should store the paymentSession response reference returned by Judopay's API. 
Use this reference from the response to populate yourPaymentSession.
Make sure you replace the payPalConfiguration object values with your own.
Display the PayPal Button
<body>

  <div id="#paypal-button-container" ></div>
  
<script>
  
  const payPalConfiguration = {
      style: {color: 'blue', height: 34},
      merchantId: 'yourPaypalMerchantId',
      amount: '1.01',
      currency: 'GBP',
      merchantPaymentReference: 'yourPaymentReference',
      judoId: 'yourJudoId',
      dynamicDescriptor: 'dynamicDescriptor',
      paymentSession: 'yourPaymentSession',
      consumer: {
          merchantConsumerReference: 'yourConsumerReference',
          firstName: 'John',
          surname: 'Doe',
          emailAddress: '[email protected]'
      },
      billingAddress: {
          address1: 'My House',
          address2: 'My Street',
          town: 'My Town',
          country: 'GB',
          postcode: 'TR14 8PA',
      },
      shippingAddress: {
          address1: 'My House',
          address2: 'My Street',
          town: 'My Town',
          country: 'GB',
          postcode: 'TR14 8PA',
      },
      onSuccess: handleSuccess,
      onError: handleError
  }
  
  judo.getPayPalButton(payPalConfiguration) 
      .then(button => {
          button.render(document.getElementById("#paypal-button-container"));    
          })
      .catch(error => handleError(error))
      
</script>
</body>
<body>

  <div id="#paypal-button-container" ></div>
  
<script>
  
  const payPalConfiguration = {
      style: {color: 'blue', height: 34},
      merchantId: 'yourPaypalMerchantId',
      amount: '1.01',
      currency: 'GBP',
      merchantPaymentReference: 'yourPaymentReference',
      judoId: 'yourJudoId',
      dynamicDescriptor: 'dynamicDescriptor',
      paymentSession: 'yourPaymentSession',
      consumer: {
          merchantConsumerReference: 'yourConsumerReference',
          firstName: 'John',
          surname: 'Doe',
          emailAddress: 'example@domain.com'
      },
      billingAddress: {
          address1: 'My House',
          address2: 'My Street',
          town: 'My Town',
          country: 'GB',
          postcode: 'TR14 8PA',
      },
      shippingAddress: {
          address1: 'My House',
          address2: 'My Street',
          town: 'My Town',
          country: 'GB',
          postcode: 'TR14 8PA',
      },
      onSuccess: handleSuccess,
      onError: handleError
  }
  
  judo.getPayPalButton(payPalConfiguration) 
      .then(button => {
          button.render(document.getElementById("#paypal-button-container"));    
          })
      .catch(error => handleError(error))
      
</script>
</body>
﻿
When the PayPal button is clicked, the Web SDK will call the method to make the transaction.
For more information on the PayPal button, see PayPal's documentation Button Render Options.
See below for more details on the parameters that create the payPalConfiguration object:
Parameter
Description
style
String
Optional﻿
Set the style for the PayPal button.
For a full list of styling options, see Styling.
merchantId
String
Optional﻿
Your PayPal Merchant ID.
To get your PayPal Merchant ID: Navigate to your PayPal Account Settings -> Business Information -> PayPal Merchant ID.
amount
Float
Required﻿
The amount to process. 
Format:
Two decimal places
For currencies using a different structure please contact Judopay for support.
currency
String
Required﻿
The currency of the transaction. Any ISO 4217 alphabetic currency code:
GBP
USD
EUR
merchantPaymentReference
String
Required﻿
Your unique reference for this payment. 
Format:
Maximum length 50 characters.
This value should be unique in order to protect your customers against duplicate transactions. If you set this reference it will be used. 

Otherwise a reference will be internally generated.
judoId
String
Required﻿
Unique ID supplied by Judopay.Specific to a merchant and/or location.
Format:
100100100
Maximum length 9 characters.
Do not include spaces or dashes.
dynamicDescriptor
String
Optional﻿
The merchant’s ‘Trading Name’ that will appear on the consumer’s statement.
The value is returned in the response within the appearsOnStatement field.
Format:
Maximum 25 characters in length.
paymentSession
String
Required﻿
The additional way to authenticate a 3D Secure 2 payments or preauths transaction.
consumer
Object
Required﻿
Consumer details:
merchantConsumerReference
firstName
surname
emailAddress
billingAddress
Object
Optional﻿
Billing address details:
address1
address2
town
country 
See here﻿ for the list of valid ISO 3166-1 format country codes.
postcode
shippingAddress
Object
Optional﻿
Shipping address details:
address1
address2
town
country
See here﻿ for the list of valid ISO 3166-1 format country codes.
postcode
onSuccess
Object
Required﻿
Callback invoked when the payment is successful.
The response object is provided as a parameter, with the following properties:
receiptId
orderId
transactionType
createdAt
status
onError
Object
Required﻿
Callback invoked when the payment fails.
The error object is provided as a parameter
﻿
﻿
Step Two: Handle the Response
﻿
﻿

Parameter	Description
style String Optional	Set the style for the PayPal button. For a full list of styling options, see Styling.
merchantId String Optional	Your PayPal Merchant ID. To get your PayPal Merchant ID: Navigate to your PayPal Account Settings -> Business Information -> PayPal Merchant ID.
amount Float Required	The amount to process. Format: Two decimal places For currencies using a different structure please contact Judopay for support.
currency String Required	The currency of the transaction. Any ISO 4217 alphabetic currency code: GBP USD EUR
merchantPaymentReference String Required	Your unique reference for this payment. Format: Maximum length 50 characters. This value should be unique in order to protect your customers against duplicate transactions. If you set this reference it will be used. Otherwise a reference will be internally generated.
judoId String Required	Unique ID supplied by Judopay.Specific to a merchant and/or location. Format: 100100100 Maximum length 9 characters. Do not include spaces or dashes.
dynamicDescriptor String Optional	The merchant’s ‘Trading Name’ that will appear on the consumer’s statement. The value is returned in the response within the appearsOnStatement field. Format: Maximum 25 characters in length.
paymentSession String Required	The additional way to authenticate a 3D Secure 2 payments or preauths transaction.
consumer Object Required	Consumer details: merchantConsumerReference firstName surname emailAddress
billingAddress Object Optional	Billing address details: address1 address2 town country See here for the list of valid ISO 3166-1 format country codes. postcode
shippingAddress Object Optional	Shipping address details: address1 address2 town country See here for the list of valid ISO 3166-1 format country codes. postcode
onSuccess Object Required	Callback invoked when the payment is successful. The response object is provided as a parameter, with the following properties: receiptId orderId transactionType createdAt status
onError Object Required	Callback invoked when the payment fails. The error object is provided as a parameter

Updated 18 Oct 2024

Alternative Payment Methods

iDEAL

PayPal

PayPal

Integrating PayPal (BETA)

Prerequisites

Step One: Display the PayPal Button

PayPal Configuration Parameter Descriptions

Step Two: Handle the Response