menu

Payment API

What's on this page

Online Payments / Payment Methods / Paypal

Paypal

Shopper Country Sale Refund Authorise / Capture Void Token Vault Mandates
Worldwide ✓ ✓ ✓

Introduction

PayPal is a trusted payment platform that allows you to securely accept payments from customers. It acts as a bridge between your business and your customers, ensuring that transactions are safe and protected.

With PayPal, you can reach customers worldwide. It supports multiple currencies and provides a seamless experience for international buyers. Whether you’re selling locally or globally, PayPal facilitates cross-border transactions.

PayPal provides seller protection, reducing the risk of chargebacks and fraud. If eligible, you’re covered against unauthorized transactions or items not received.

Guidelines

  1. Create a payment with the payment method set to paypal and use a webhook or notification.
  2. Redirect your customer to the payment url, field payUrl in the payment response.
  3. Once the customer completes the payment, they are redirected to the return url defined in the payment request field returnUrl.
  4. When CCV receives the payment confirmation from Paypal, the payment becomes successful.
  5. If you used a webhook or notification, CCV will inform you about the change. Alternatively, you can also query they payment status on regular intervals.

Collecting

Paypal is a non-collecting or switching payment method, i.e. CCV does not receive the money from Paypal.

You will receive the merchant directly from Paypal as configured in your Paypal account. CCV does not provide any information about payouts from Paypal.

Method API details

Payment

Request

Paypal does not require method specific input.

{
    "amount": 9.99,
    "currency": "eur",
    "method": "paypal",
    "returnUrl": "https://shop/return?order=123456",
    "webhookUrl": "https://shop/payhook?order=123456",
    "merchantOrderReference": "123456",
    "description": "Order 123456",
    "language": "eng"
}

Response

{
  "lastUpdate": 1711534123144,
  "methodTransactionId": "0K984822MX7287300",
  "description": "Order 123456",
  "merchantOrderReference": "123456",
  "returnUrl": "https://shop/return?order=123456",
  "payUrl": "https://www.sandbox.paypal.com/checkoutnow?token=0K984822MX7287300",
  "amount": 9.99,
  "status": "pending",
  "created": 1711534122977,
  "reference": "P240327100842976CB87E196.R",
  "method": "paypal",
  "type": "sale",
  "language": "eng",
  "currency": "eur"
}
Paypal Payment Details
Name Description
mandateId The CCV mandate id attached to the transaction if a mandate was used
acquirerResponseCode An error response code further explaining the failed status. Available when received.
acquirerResponseCodeDescription An error response code description further describing the failed status. Available when received.

Example

{
   "mandateId": "MAN240205130156564CB87E192.0",
   "acquirerResponseCode": "TRANSACTION_REFUSED",
   "acquirerResponseCodeDescription": "The request was refused"
}

Refund

Paypal does not require method specific input.

{
  "reference": "P240226130441921CB87E195.Y",
  "description": "Refund of Order 123456"
}