PayPal

Features
Method	Async - GET Redirect
Countries	Global
Processing currencies	AUD, BRL, CAD, CHF, CZK, DKK, EUR, GBP, HKD, HUF, JPY, MXN, MYR, NOK, NZD, PHP, PLN, SEK, SGD, THB, TWD, USD
Increments	-
Captures	-
Partial/Multiple partial captures	-
Cancels	-
Partial/Multiple partial cancels	-
Refunds	✅
Partial/Multiple partial refunds	✅
Recurring	-
Installments	-
Credits	-
Disputes	-
Min Amount	0.01
Account verification	-

PayPal is an online payment system that allows you to send and receive money around the world. You can link your credit card, debit card, or bank account. You can also set up a PayPal Balance account.

When a consumer shops online using the PayPal payment method, the merchant sends a payment to the PSP.

The merchant redirects to the PayPal page and allows the customer to complete the purchase.

Payment flow

Payment

Request

{
    "processingAccountId": "2HdN2jq6XWmlkhqRC2gDTNYCvNH",
    "merchantReference": "c5211d6b-0178-49f8-a06b-69df097a712f",
    "amount": {
        "value": 200,
        "currency": "eur"
    },
    "paymentMethod": {
        "type": "paypal",
        "paypal": {
            "returnUrl": "https://merchant.site/complete-payment",
            "consumer": {
                "name": "John Doe"
            },
            "order": {
                "items": [
                    {
                        "name": "red shoes",
                        "quantity": 1,
                        "unitAmount": {
                            "value": 200,
                            "currency": "eur"
                        }
                    }
                ]
            }
        }
    }
}

Response

{
    "id": "27yiW9MgzBtwiodreuNOXk0rtIw",
    "merchantReference": "c5211d6b-0178-49f8-a06b-69df097a712f",
    "status": "pending",
    "trackingUrl": "/v1/tracks/payments/{trackId}",
    "reason": {
        "code": "required_next_step",
        "description": "An additional step is needed to complete the payment."
    },
    "nextStep": {
        "type": "redirect",
        "redirect": {
            "method": "get",
            "url": "https://payment.method/complete"
        }
    }
}