Menu

PayPal (coming soon)

A secure and globally accepted online payment transfer.

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, supports 25 currencies and is a mainstay of APM payments.

Feature summary

Payment typeCountriesRecurringReversePartial ReverseDisputesAuth onlyAuth and Settlement (Sale)
Digital WalletGlobal acceptance
  • Partial refund - yes
  • Partial cancel- No
Handled directly via PayPal

Acceptance currencies

CurrencyCurrency Codes
Australian dollarAUD
Brazilian real 2BRL
Canadian dollarCAD
Czech korunaCZK
Danish kroneDKK
EuroEUR
Hong Kong dollarHKD
Hungarian forintHUF
Indian rupeeINR
Israeli new shekelILS
Japanese yenJPY
Malaysian ringgitMYR
Mexican pesoMXN
New Taiwan dollarTWD
New Zealand dollarNZD
Norwegian kroneNOK
Philippine pesoPHP
Polish złotyPLN
Pound sterlingGBP
Singapore dollarSGD
Swedish kronaSEK
Swiss francCHF
Thai bahtTHB
United States dollarUSD

Visualize our PayPal flow:

Discover our APM API by clicking on the scenarios. We show you the flow of requests, and actions related to the selected request.

UserPayPalAPIsalequeryreversepartialreverse

Make a PayPal request

Example request

Copied!
{
    "transactionReference": "Memory265-13/08/1876",
    "merchant":
    {
        "entity": "MindPalaceLtd"
    },
    "instruction":
    {
        "narrative":
        {
            "line1": "Mind Palace Ltd"
        },
        "value":
        {
            "amount": 35,
            "currency": "GBP"
        },
        "requestAutoSettlement": {
            "enabled": true
            },
        "paymentInstrument":
        {
            "type": "paypal",
            "shopperEmailAddress": "shopper@example.com",
            "billingAddress":
            {
                "address1": "221B Baker Street",
                "address2": "Marylebone",
                "address3": "Westminster",
                "postalCode": "NW1 6XE",
                "city": "London",
                "state": "Greater London",
                "countryCode": "GB"
            },
            "shippingAddress":
            {
                "address1": "The Palatine Centre",
                "postalCode": "DH1 3LE",
                "city": "Durham",
                "state": "County Durham",
                "countryCode": "GB"
            },
            "successURL": "http://https://example.com/success",
            "pendingURL": "http://https://example.com/pending",
            "failureURL": "http://https://example.com/failure",
            "cancelURL": "http://https://example.com/cancel",
            }
    },
}

Optional/conditional PayPal parameters

ParameterRequired?DescriptionData typeLength
instruction.paymentInstrument.typeAn object that contains the payment type and details. It defines which alternative payment method you wish to use. Value is paypal.ObjectN/A
instruction.requestAutoSettlementSettles the transaction automatically when set to "true".ObjectBoolean
"true" or "false". Default: "false".
paymentInstrument.shopperEmailAddressThe email adddress of your customer.Stringtbc
paymentInstrument.billingAddressThe billing address of your customer.ObjectN/A
paymentInstrument.billingAddress.address1First line of the billing address.
Condition: Must be provided if you send paymentInstrument.billingAddress.		String1-85
paymentInstrument.billingAddress.address2Second line of the billing address.String0-85
paymentInstrument.billingAddress.address3Third line of the billing address.String0-85
paymentInstrument.billingAddress.cityThe city of the billing address.String0-50
paymentInstrument.billingAddress.countryCodeThe country of the billing address.
Condition: Must be provided if you send paymentInstrument.billingAddress. Followsalpha 2 ISO 3166-1standard.		String2
paymentInstrument.billingAddress.postalCodeThe poste code of the billing address.
Condition: Must be provided if you send paymentInstrument.billingAddress.		String1-15
paymentInstrument.billingAddress.stateThe state of the billing address.String1-50
paymentInstrument.shippingAddressThe shipping address of your customer.ObjectN/A
paymentInstrument.shippingAddress.address1First line of the shipping address.
Condition: Must be provided if you send paymentInstrument.shippingAddress.		String1-85
paymentInstrument.shippingAddress.address2Second line of the shipping address.String0-85
paymentInstrument.shippingAddress.address3Third line of the shipping address.String0-85
paymentInstrument.shippingAddress.cityThe city of the shipping address.String0-50
paymentInstrument.shippingAddress.countryCodeThe country of the shipping address.
Condition: Must be provided if you send paymentInstrument.shipppingAddress. Followsalpha 2 ISO 3166-1standard.		String2
paymentInstrument.shippingddress.postalCodeThe poste code of the shipping address.
Condition: Must be provided if you send paymentInstrument.shippingAddress.		String1-15
paymentInstrument.shippingAddress.stateThe state of the shipping address.String1-50

You can find our standard parameters on ourget started page.

Response

Successful request response

  • an HTTP code 201
  • an id which is unique to the payment, we recommend storing the "id" as this can be used 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

Example Response

Copied!
{
  "id": "3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f",
  "url": "https://hpp.worldpay.com/app/hpp/xyz/integration/wpg?Ticket=12345678&OrderKey=blah",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay.com/apms/3Ihrz_xFV1nTRAHhJABserDF09eNdqnSHh2H8qlv7QIZ4iW8JjMy1wo4b2GozzFtfnOUMIZGm4eSqTixJe1tGDzD3NTuoxp7Ud1N920NPyBiaK1MePsYPNh4StVn5GLv9dz9tm3t0o9KS2dze2cQ2iJdjRiX7-j4OEhFc5W4W6hK1prAjyQIHthwfovFL63f"
    }
  }
}

Note: In case of an error, you can get further information in ourerror reference.

Next Steps

Manage your PayPal payment