PayPal

A secure and globally accepted online payment transfer.

Note

Make yourself familiar with our API Principles to ensure a resilient integration.

Product overview

Why use PayPal

PayPal is a global payment method with strong consumer recognition and trust. It is also one of the most popular APMs in the world. PayPal opens up a large customer base who already have PayPal accounts and can make purchases with a payment flow that they are comfortable with.

It is accepted in over 200 countries and supports 25 currencies.

Feature summary

Payment type	Countries	Pay later	Recurring	Reversals	Partial Reversals	Disputes	Auth only	Auth and Settlement (Sale)	Airline data	PayPal risk data	Shipping and tracking info	Venmo
Digital Wallet	Global acceptance	✅	❌	Refund - yes Cancel - yes	Partial refund - yes Multiple refunds/Partial cancel - no	Handled directly via PayPal	✅	✅	❌	❌	❌	❌

Acceptance currencies

Currency	Currency Codes
Australian Dollar	AUD
Brazilian Real	BRL
Canadian Dollar	CAD
Czech Koruna	CZK
Danish Krone	DKK
Euro	EUR
Hong Kong Dollar	HKD
Hungarian Forint	HUF
Indian Rupee	INR
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 Złoty	PLN
Pound Sterling	GBP
Singapore Dollar	SGD
Swedish Krona	SEK
Swiss Franc	CHF
Thai Baht	THB
United States Dollar	USD

Note

For use of PayPal in the US please contact your Relationship Manager.

Payment flows

There are two different ways to integrate PayPal:

Redirect URL mechanism
Smart Button

Redirect URL

Your customer is redirected to a web browser to log into PayPal where they complete the payment.

Smart Button

Your customer clicks on the Smart Button, a pop-up window opens on top of their payment screen.

You must integrate using the PayPal SDK using the JavaScript SDK script configuration developer guide.

Important

The payment-source within the PayPal SDK must be "paypal" when integrating with Access Worldpay. This enables the PayPal option within the SDK. Other payment methods, offered by the PayPal SDK, will not work with Access Worldpay.

You can also customize the PayPal Smart button. The options are:

the size, color and shape of the button
the language that appears on the buttons
the layout of the button: horizontal or vertical

Get started

Get started using our API Reference and set your headers.

Request

POST https://try.access.worldpay.com/apmPayments

Example request

application/json

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "paypal",
    "value": {
      "amount": 35,
      "currency": "GBP"
    },
    "narrative": {
      "line1": "MindPalace"
    },
    "paymentInstrument": {
      "type": "direct",
      "billingAddress": {
        "address1": "221B Baker Street",
        "address2": "Marylebone",
        "address3": "Westminster",
        "postalCode": "NW1 6XE",
        "city": "London",
        "state": "Greater London",
        "countryCode": "GB"
      }
    },
    "settlement": {
      "auto": true
    },
    "resultUrls": {
      "cancel": "https://example.com/cancel",
      "failure": "https://example.com/failure",
      "pending": "https://example.com/pending",
      "success": "https://example.com/success"
    },
    "shipping": {
      "firstName": "James",
      "lastName": "Moriarty",
      "address": {
        "address1": "The Palatine Centre",
        "postalCode": "DH1 3LE",
        "city": "Durham",
        "state": "County Durham",
        "countryCode": "GB"
      }
    },
    "customer": {
      "email": "moriarty@example.com"
    }
  }
}

Parameters

transactionReferencestring[ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

merchantobject(MerchantV2)required

merchant.entitystring[ 3 .. 32 ] characters^([a-zA-Z0-9\- ]*)$required

Used to route the request in Access Worldpay, created as part of on-boarding.

Example: "default"

instructionobject(InstructionV2)required

Object that contains the payment type and details.

instruction.methodstringrequired

Type of payment method

Value"alipay_cn"

Discriminator

instruction.valueobject(Value)required

The value of the payment.

instruction.value.amountinteger(int64)[ 1 .. 2147483647 ]required

The amount in the lowest denomination of the currency e.g. pennies for GBP, cents for USD.

Example: 12

instruction.value.currencystringrequired

The supported ISO 4217 currency codes.

Enum"AED""AFN""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD"

instruction.narrativeobject(NarrativeBase)required

instruction.narrative.line1string[ 1 .. 24 ] characters^[a-zA-Z0-9-., ]*$required

The description shown on your customer's bank statement for the payment.

Example: "MindPalace"

instruction.paymentInstrumentobject(AlipayCnInstrumentV2)required

instruction.paymentInstrument.typestringrequired

Type of instruction

Value"direct"

instruction.paymentInstrument.languagestring

Your customer's language.

Enum"aa""ab""ae""af""ak""am""an""ar""as""av"

instruction.resultUrlsobject(ResultUrlsAlipay)required

instruction.resultUrls.cancelstring

The URL your customer is redirected to, after a cancelled payment outcome.

Example: "https://worldpay.com/cancel"

instruction.resultUrls.failurestringrequired

The URL your customer is redirected to, after a failed payment outcome.

Example: "https://worldpay.com/failure"

instruction.resultUrls.pendingstringrequired

The URL your customer is redirected to, after a pending payment outcome.

Example: "https://worldpay.com/pending"

instruction.resultUrls.successstringrequired

The URL your customer is redirected to, after a successful payment outcome.

Example: "https://worldpay.com/success"

instruction.deviceDataobject(DeviceData)

instruction.customerobject(CustomerWithName)

Recommendation

We suggest you provide the cancelURL,failureURL, pendingURL and successURL attribute to redirect your customer to, once you have received the payment result.

Response

Successful response

an HTTP code 201
a paymentId which is unique to the payment - we recommend storing the "id", as you can use it to manage the payment later
a url to redirect your customer to the APM provider to complete the payment
a link to query the payment status
an object which will give flow information such as method (e.g. paypal), type (sdk for a Smart Button flow or redirect for a Redirect URL flow) and an sdk token
a commandId generated by us identifying a single merchant interaction (e.g. cmdYNdIHBPJwbkjLiykzTx0)

Note

for the Smart Button flow use the sdkReference to generate the Smart Button
for the redirect flow use the url in the response to redirect your customer

Example response

{
  "paymentId": "nFxASqw-LV9HE_rr1mMONP6OuaBhNYiq0jRwvvUBRLffpu0O_8mOnTpFSIM9gnTSg8thuF8qvuzMKHjhAUKA-SBywF4F_ufX78jkgX7yoPwA8HF_HMLM0RSLDKrlDpMxs5bSRRbjItu_Me3kIkraos_XGMXXDzWYsmzASPr6BGo",
  "lastEvent": "pending",
  "_links": {
    "self": {
      "href": "https://access.worldpay.com/apmPayments/nFxASqw-LV9HE_rr1mMONP6OuaBhNYiq0jRwvvUBRLffpu0O_8mOnTpFSIM9gnTSg8thuF8qvuzMKHjhAUKA-SBywF4F_ufX78jkgX7yoPwA8HF_HMLM0RSLDKrlDpMxs5bSRRbjItu_Me3kIkraos_XGMXXDzWYsmzASPr6BGo"
    }
  },
  "_actions": {
    "confirmPayment": {
      "href": "https://access.worldpay.com/apmPayments/nFxASqw-LV9HE_rr1mMONP6OuaBhNYiq0jRwvvUBRLffpu[…]rlDpMxs5bSRRbjItu_Me3kIkraos_XGMXXDzWYsmzASPr6BGo/confirmations"
    }
  },
  "paymentInstrument": {
    "method": "paypal",
    "type": "sdk",
    "sdkReference": "2HG28153DX910101U"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}

Errors

Check out our API reference for the full error code schema.

Payment flows diagrams

PayPal redirect flow

The payment flow varies depending on the payment experience you want to offer and how you settle/capture the payment. We offer two options for this flow:

auto settlement
manual settlement

Please refer to the main page for the redirect flow diagram.

PayPal Smart Button flow

Payment confirmation

Once your customer has closed the PayPal iframe, you must confirm the payment when using the PayPal Smart Button. This is done by using the confirmPayment href returned in the payment request response.

Make a POST request on the link:actions action link returned in your payment response.

POST https://try.access.worldpay.com/apmPayments/nFxASqw-LV9HE_rr1mMONDTNO21DI7iBqIBDP8tbNT_pHfdVKepSMngqe9EDiBI1pHXEu-SbvqJyvSludyCd-2L21mL7uoB8zl62Ayz7E3GblXYsLnrW2-IZDMChfXfwWt7xrjVsKEPMGearp4PdIQp8hQ6k4_KTkZa_frsM4TQ/confirmations

Note

No request body is needed for this request.

For greater understanding of the PayPal Smart Button flow, view the sequence diagram below.

Next steps

Manage your PayPal payment

PayPal

Why use PayPal

Feature summary

Acceptance currencies

Payment flows

Redirect URL

Smart Button

Get started

Request

Example request

Parameters

Response

Successful response

Example response

Errors

Payment flows diagrams

PayPal redirect flow

PayPal Smart Button flow

Payment confirmation

Do you like our page?