---
title: "paypal/recipients"
method: GET
path: "/paypal/recipients"
tags: ["PayPal Endpoints"]
---

# paypal/recipients

`GET /paypal/recipients`

## Request

- Base URL: `https://earthnode-dev.vopay.com/api/v2`
- URL: `https://earthnode-dev.vopay.com/api/v2/paypal/recipients`
- Auth: none declared

This endpoint allows you fetch a list all of your PayPal recipients

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientControlled` boolean
- `Limit` integer
- `Offset` integer

## Response `200`

- object
  - `Success` boolean, required: true if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `PaypalRecipients` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. A collection of PayPal recipients
    - `0` object
      - `RecipientName` string, required: The name of the recipient
      - `RecipientID` string, required: The email address, phone number, or PayPal ID.
      - `PayPalRecipientType` string, required: The type of the recipient
      - `PayPalToken` string, required: The Token associated with the recipient
      - `ClientControlledPayPalAccount` string, required: Set to 1 if the PayPal recipient is linked to your VoPay account.
      - `IsDefault` string, required: Set to 1 if the PayPal recipient is the default

---

[API](https://skmtc.dev/vopay/apis/payment-methods.md) - [All operations](https://skmtc.dev/vopay/apis/payment-methods/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/payment-methods/revisions/b566c8002410?raw)