Create batch PayPal transfers

Authentication requires either the x-api-key header or, for enhanced security, both x-signature and x-timestamp headers.`

POST /api/v1/paypal-payment/transfers/batch

Request parameters:

Parameter	Type	Is optional	Description
items	array	false	Array of PayPal Transfer objects

PayPal Transfer Object:

Parameter	Type	Is optional	Description
requestId	string	false	Idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.
paymentDate	string	true	Date when the transfer should be done
recipientDestinationType	string	false	Type of the paypal recipient destination. Default: `EMAIL`
recipientDestination	string	false	Paypal recipient destination
currency	string	false	Currency you would like to pay in. Must be in ISO 4217 format.
amount	number	false	Amount you would like to transfer
reason	string	true	Reason for your transfer
requireApproval	boolean	true	If `true`, the transfer requires approval and will be in a pending state until approved
reference	string	true	Referense for your transfer
internalReference	string	true	Internal reference for your transfer
recipientType	string	false	Type of the recipient. One of `COMPANY` or `INDIVIDUAL`
recipientFirstName	string	true	First name of the recipient
recipientLastName	string	true	Last name of the recipient
recipientCompanyName	string	true	Company name of the recipient
recipientEmail	string	true	Email address of the recipient. It's not use for a executing a payment
recipientNickName	string	true	Nick name of the recipient
recipientCity	string	true	Recipient city
recipientState	string	true	Recipient state
recipientCountry	string	true	Recipient country. Must be in ISO 3166-1 alpha-2 format
recipientPostalCode	string	true	Recipient postal code
recipientAddress	string	true	Recipient address

Example response:

{
  "items": [
    {
      "id": 1,
      "requestId": "79ab47a2-6148-481e-b04a-1e34c34dae0b",
      "paymentDate": "2024-08-31T12:00:00.000Z",
      "recipientDestinationType": "EMAIL",
      "recipientDestination": "[email protected]",
      "paymentExecutionDate": "2021-08-31T12:00:00.000Z",
      "currency": "USD",
      "status": "PROCESSING",
      "amount": 100,
      "reason": null,
      "requireApproval": false,
      "reference": "12332",
      "internalReference": null,
      "recipientType": "INDIVIDUAL",
      "recipientFirstName": "John",
      "recipientLastName": "Does",
      "recipientCompanyName": null,
      "recipientEmail": "[email protected]",
      "recipientNickName": "Joe",
      "recipientCity": "New York",
      "recipientState": "California",
      "recipientCountry": "US",
      "recipientPostalCode": "0128",
      "recipientAddress": null,
      "createdAt": "2024-08-31T12:00:00.000Z"
    }
  ]
}