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

# paypal/default-recipient

`GET /paypal/default-recipient`

## Request

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

This endpoint retrieves the default PayPal recipient associated with your VoPay account

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `ClientAccountID` string

## 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
  - `DefaultPayPalRecipient` object, required: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items. Collection of PayPal Recipient records
    - `0` object
      - `ClientControlledPayPalAccount` string, required: Set to 1 if the PayPal recipient is linked to your VoPay account.
      - `RecipientName` string, required: Recipient's name
      - `RecipientID` string, required: The email address, phone number, or PayPal ID.
      - `PayPalRecipientType` string, required: The type of PayPal recipient record. Accepted values: EMAIL, PHONE, or PAYPAL_ID
      - `IsActive` string, required: Determine if the PayPal recipient is active or not
      - `IsDefault` string, required: Determine if this is the default PayPal recipient for the given account or not
      - `PayPalToken` string, required: The token associated with the PayPal recipient record
      - `DateAdded` string, date-time, required: This timestamp indicates when the PayPal recipient record was added.

---

[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)