---
page_source: https://docs.juspay.io/payout-brazil/docs/integration/paypal-linkwallet
page_title: Paypal LinkWallet 
---

## API Version: default


# Paypal LinkWallet API



Merchants can use this API to retrieve the PayPal Authorization URL.Once you receive the `paypalAuthorizationUrl` in the response, you can navigate to it. This URL will transfer control to PayPal for the user to log in and provide their consent. After PayPal completes the login and consent process, control will be handed back to Juspay. Once Juspay finishes its processing, it will redirect control to the merchant's return URL.

Merchants must register the following Juspay return URLs in their PayPal dashboard:

* **Production:** `https://api.juspay.io/payout/paypalReturnUrl`
* **Sandbox:** `https://api.sandbox.juspay.io/payout/paypalReturnUrl`## Endpoints:
- Sandbox: https://api.sandbox.juspay.io/payout/merchant/v1/linkwallet

- Production: https://api.juspay.io/payout/merchant/v1/linkwallet

## Request Type: 
POST

## Authorization:

#### Basic Auth:
Consists of two parts.

* Username: API Key obtained from Juspay dashboard
* Password: Empty string

**Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==** 
- Tags: String, Mandatory
## Headers:

#### x-merchantid:
Pass merchant-id provided by Juspay
- Tags: String

#### Content-Type:
application/json
- Tags: String
## Sample Code Snippets:
### Sample Request:

#### Request Code Snippet:

```request
curl --request POST \
--url https://api.juspay.io/payout/merchant/v1/linkwallet \
--header 'x-merchantid: <merchant id>' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic (b64 encoded API key)' \
--data-raw '{
    "merchantReturnUrl" : "https://www.abc.com/",
    "customerId" : "juspaycustomer1",
    "customerPhone" : "9475839573",
    "customerEmail" : "tusharjuspay1@example1.com",
    "beneficiaryID" : "loginflowid1",
    "payoutMethodType" : "EMAIL"
}'

```

### Sample Response:

#### Response:
```json
{"success":false,"message":"No Data found for the given path"}
```

## Body Parameters:
### Parameters:

#### merchantReturnUrl:
- Description: Provide your return URL so that, once the Juspay process is completed, we can redirect control back to you.
- Tags: String, Mandatory

#### customerId:
- Description: Unique ID for the customer generated by the merchant.
- Tags: String, Mandatory

#### customerPhone:
- Description: Customer mobile number - The customer’s mobile number. If the actual number is unavailable, you may use a placeholder or dummy value. The number should contain only the digits without any country code or special characters. 

For instance, a valid entry for a Brazilian phone number would be: 4112345678.
- Tags: String, Mandatory

#### customerEmail:
- Description: Customer email address - you may pass a dummy value in case this information is not available at your endFor example, [example@mail.com](mailto:example@mail.com), "example" is the email prefix, and "[mail.com](http://mail.com)" is the email domain.
- Tags: String, Mandatory

#### beneficiaryID:
- Description: For each verification to have a unique reference
- Tags: String, Mandatory

#### payoutMethodType:
- Description: This is used to set the primary payout method for the current `beneficiaryID`. The method can be either `EMAIL` or `PAYPAL_ID.`
- Tags: String
## API Responses:
### 200:

#### 200 : paypalAuthorizationUrl:
- Description: This `paypalAuthorizationUrl` is used to redirect control to PayPal for user login.
- Value:
- Tags: String
### 400:

#### object:
- Description: {}
- Tags: Object