PayPal is a global online payment platform that allows individuals and businesses to send and receive money securely over the internet. Founded in 1998, it supports transactions in multiple currencies, offers buyer and seller protection, and can be linked to bank accounts, debit cards, or credit cards, making it a widely trusted option for e-commerce, freelance payments, and personal transfers worldwide. Learn more about PayPal.

🚧
PayPal is currently offered as processing only. Settlement and disputes are handled directly by PayPal.

Payment method properties


Markets (consumer)	Global
Processing currencies	`AUD` `BRL` `CAD` `CZK` `DKK` `EUR` `HKD` `HUF` `JPY` `MYR` `MXN` `NOK` `NZD` `PHP` `PLN` `GBP` `SGD` `SEK` `CHF` `TWD` `THB` `USD` IMPORTANT:* For `HUF` and `TWD` minor units are not supported. Always set the minor units to 00.
Consumer currencies	Global
Authentication methods	`REDIRECT`
Authentication timeout	73 hours
Minimum payment amount	0.01 USD or equivalent.
Maximum payment amount	Subject to wallet balance, card limits or bank account balance (whichever is applicable). PayPal may provide Pay Later options to consumers in select countries, depending on the transaction amount. Learn more.
Payment instrument	`PASSTHROUGH_WALLET`
Recurring payments	No
Separate captures	No
Refund	Full, Partial and multiple partial refunds available
Refund validity	180 days
Disputes	N/A processing only
Settlement risk	N/A processing only

Make a PayPal payment

PayPal payments follow our standardized REDIRECT payment flow. Enabling you to offer a seamless desktop experience. We recommend including all relevant settings for any authentication methods you support.

To create a PayPal payment, you'll need to provide the following data at minimum when calling our payment charges endpoint:

Field	Description
`paymentMethod`	`PAYPALWALLET`
`amount.value`	The amount to be paid in the smallest units of the currency used.
`amount.currency`	`AUD` `BRL` `CAD` `CZK` `DKK` `EUR` `HKD` `HUF` `JPY` `MYR` `MXN` `NOK` `NZD` `PHP` `PLN` `GBP` `SGD` `SEK` `CHF` `TWD` `THB` `USD`
`consumer.country`	The country of residence of the consumer.
`order.ShippingAddress.lastName`	The last name of the person holding the shipping address.
`order.shippingAddress.street`	Street name, house number and other details such as apartment number or door number
`order.shippingAddress.postalCode`	The address postal code.
`order.shippingAddress.city`	The address city.
`order.shippingAddress.country`	The address region.
authenticationSettings: REDIRECT `settings.returnUrl`	Specify the URL to which the consumer should be redirected after completing the payment. This is required for the `REDIRECT` payment flow.

Request

POST /v1/payment-charges

{
    "paymentMethod": "PAYPALWALLET",
    "amount": {
        "value": 1000,
        "currency": "USD"
    },
    "consumer": {
        "country": "US"
    },
    "order": {
        "shippingAddress": {
            "lastName": "Smith",
            "street": "1234 Elm Street NW",
            "postalCode": "20001",
            "city": "Washington, D.C.",
            "country": "US"
        }
    },
    "authenticationSettings": [
        {
            "type": "REDIRECT",
            "settings": {
                "returnUrl": "https://www.webshop.com/order-results-page"
            }
        }
    ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
    "id": "charge_XysOj6Q0bWKTkqtrvEOg0",
    "paymentMethod": "PAYPALWALLET",
    "paymentMedium": "ECOMMERCE",
    "scheduleType": "UNSCHEDULED",
    "instrumentId": "instr_hir1LQlB9mNxr6kgMNYBI",
    "currency": "USD",
    "country": "US",
    "status": "AUTHENTICATION_PENDING",
    "consumer": {
        "country": "US"
    },
    "order": {
        "orderItems": [],
        "shippingAddress": {
            "lastName": "Smith",
            "street": "1234 Elm Street NW",
            "postalCode": "20001",
            "city": "Washington, D.C.",
            "country": "US"
        }
        "industryData": []
    },
    "authenticationMethods": [
        {
            "details": {
                "requestUrl": "https://redirection-target.ppro.com",
                "requestMethod": "GET"
            },
            "type": "REDIRECT"
        }
    ],
    "authorizations": [
        {
            "id": "authz_ZlJ5cTeMRSNcBk5ccNXbL",
            "amount": 1000,
            "status": "AUTHENTICATION_PENDING",
            "createdAt": "2025-08-14T14:49:13.992Z",
            "updatedAt": "2025-08-14T14:49:13.992Z"
        }
    ],
    "captures": [],
    "refunds": [],
    "discards": [],
    "voids": [],
    "createdAt": "2025-08-14T14:49:13.360Z",
    "updatedAt": "2025-08-14T14:49:13.992Z",
    "_links": {
        "authorizations": {
            "href": "/v1/payment-charges/charge_XysOj6Q0bWKTkqtrvEOg0/authorizations"
        },
        "captures": {
            "href": "/v1/payment-charges/charge_XysOj6Q0bWKTkqtrvEOg0/captures"
        },
        "refunds": {
            "href": "/v1/payment-charges/charge_XysOj6Q0bWKTkqtrvEOg0/refunds"
        },
        "discards": {
            "href": "/v1/payment-charges/charge_XysOj6Q0bWKTkqtrvEOg0/discards"
        },
        "voids": {
            "href": "/v1/payment-charges/charge_XysOj6Q0bWKTkqtrvEOg0/voids"
        }
    }
}

Pick the desired authentication method

REDIRECT

Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
The consumer will be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for PayPal, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_hrp9UWaQN6RgOvaNC1jgK",
    "type": "PASSTHROUGH_WALLET"
}

Sandbox testing

Sign up for a new PayPal account, or log in with an existing one, and go to the PayPal Developer Dashboard. From there, you’ll have access to a Personal sandbox account. Use the associated email and password to complete payments in the sandbox environment.