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 for the PayPal account of the recipient
  • shopperName
  • dateOfBirth

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":"TestMerchant",
   "recurring":{
      "contract":"PAYOUT"
   },

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

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":"TestMerchant"
}

The response will contain a pspReference and a response.

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