JavaScript is disabled. Some features may not work. You can also read the static version: View text version

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

Request

Response

API Endpoints

Sandbox Link

POST

https://api.sandbox.juspay.io/payout/merchant/v1/linkwallet

Production Link

POST

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

                      Basic Auth
                      *
                      

String

Mandatory

Consists of two parts.

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

Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==

                      x-merchantid
                      
                      

String

Pass merchant-id provided by Juspay

                      Content-Type
                      
                      

String

application/json

Body

                      merchantReturnUrl
                      *
                      

String

Mandatory

Provide your return URL so that, once the Juspay process is completed, we can redirect control back to you.

                      customerId
                      *
                      

String

Mandatory

Unique ID for the customer generated by the merchant.

                      customerPhone
                      *
                      

String

Mandatory

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.

                      customerEmail
                      *
                      

String

Mandatory

Customer email address - you may pass a dummy value in case this information is not available at your end
For example, example@mail.com, "example" is the email prefix, and "mail.com" is the email domain.

                      beneficiaryID
                      *
                      

String

Mandatory

For each verification to have a unique reference

                      payoutMethodType
                      
                      

String

This is used to set the primary payout method for the current beneficiaryID. The method can be either EMAIL or PAYPAL_ID.

Response Body

                      200 : paypalAuthorizationUrl
                      
                      

String

This paypalAuthorizationUrl is used to redirect control to PayPal for user login.

Response Body

                      object
                      
                      

Object

{}