Search

Are you looking for test card numbers?

Would you like to contact support?

Online-payment icon

Payouts to a PayPal account

To make payouts using PayPal, you must give the API user the Initiate transactions to multiple recipients in a single batch permission.

To make a payout to a PayPal account, make a /storeDetailAndSubmitThirdParty call, including: 

  • selectedBrandpaypal
  • emailId: the email address for the PayPal account of the recipient (for the first payout)
  • paypal.payerId: the payer ID of the PayPal account of the recipient (for subsequent payouts)
  • shopperName
  • dateOfBirth

For the first payout, use the emailId field and enter the email address of the recipient's PayPal account. After a successful payout, you will receive a notification that contains the paypal.payerId. For subsequent payouts, use the paypal.payerId field instead of the emailId field. The payer ID stays the same for this recipient, even if they change their PayPal email address.

For a list of supported countries for payouts to PayPal accounts, refer to Third-party payouts.

{
   "amount":{
      "currency":"EUR",
      "value":1750
   },

   "selectedBrand":"paypal",
   "additionalData":{
      "tokenDataType":"PayPal",
      "emailId":"EmailUsedForPayPalAccount@example.com",
      "paypal.payerId":"AK5HCWWRUV2KL"
   },
   "shopperName":{
      "firstName":"Test",
      "gender" : "FEMALE",
      "lastName":"Test2"
   },
   "dateOfBirth": "1982-07-17",
   "entityType" : "NaturalPerson",
   "nationality" : "NL",

   "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
   "recurring":{
      "contract":"PAYOUT"
   },

   "reference":"Test Payout",
   "shopperEmail":"test@company.com",
   "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j"
}

The response will contain a pspReference and a resultCode.

{
   "pspReference":"9915003645882507",
   "resultCode":"[payout-submit-received]"
}

To complete the payout, send a request to the /confirmThirdParty endpoint, passing the pspReference from the previous response as an originalReference field value.

{
   "originalReference":"9915003645882507",
   "merchantAccount":"YOUR_MERCHANT_ACCOUNT"
}

The response will contain a pspReference and a response.

{
   "pspReference":"9915003646742627",
   "response":"[payout-confirm-received]"
}