Find a list of eligible payment methods.

Get a list of eligible payment methods based on the input parameters provided.

Authorization

Oauth2 https://uri.paypal.com/services/payments/realtimepayment, https://uri.paypal.com/services/payments/payments-ready, Braintree:PaymentsReady, https://uri.paypal.com/services/payments/client-payments-eligibility

AuthorizationBearer <token>

OAuth 2.0 authentication

In: header

Scope: https://uri.paypal.com/services/payments/realtimepayment, https://uri.paypal.com/services/payments/payments-ready, Braintree:PaymentsReady, https://uri.paypal.com/services/payments/client-payments-eligibility

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Match^.*$

Length1 <= length <= 10000

User-Agent?Schema Object for standard headers

A characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent. API calls made by PayPal SDKs SHOULD be identified using this request header.

Match^.*$

Length1 <= length <= 16000

PayPal-Client-Metadata-Id?GUID

A GUID value originating from Fraudnet and Dyson passed from external API clients via HTTP header. The value is used by Risk decisions to correlate calls which, in turn, might result in lower decline rates..

Match^[A-Za-z0-9-{}(),]*$

Length1 <= length <= 68

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

Request samples

Response samples

{
  "eligible_methods": {
    "venmo": {
      "can_be_vaulted": true
    }
  }
}

{
  "name": "INVALID_REQUEST",
  "debug_id": "b1d1f06c7246c",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema",
  "details": [
    {
      "field": "/customer/country_code",
      "value": "USA",
      "location": "body",
      "issue": "INVALID_STRING_LENGTH",
      "description": "The value of a field is either too short or too long."
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/payments/v2/#errors",
      "rel": "information_link",
      "method": "GET",
      "encType": "application/json"
    }
  ]
}

{
  "name": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "debug_id": "90bff07028f7f",
  "details": [
    {
      "field": "/purchase_units/amount/currency_code",
      "value": "III",
      "issue": "INVALID_CURRENCY_CODE",
      "description": "Currency code is invalid. Please refer https://developer.paypal.com/docs/integration/direct/rest/currency-codes/ for list of supported currency codes."
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/payments/v2/#errors",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

Match^.*$

Length1 <= length <= 10000

User-Agent?Schema Object for standard headers

Match^.*$

Length1 <= length <= 16000

PayPal-Client-Metadata-Id?GUID

Match^[A-Za-z0-9-{}(),]*$

Length1 <= length <= 68

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customer?

Customer who is making a purchase from the merchant/partner.

purchase_units?array<>

Array of purchase units.

Items1 <= items <= 10

preferences?

Preferences of merchant/partner consuming the API.

{ "name": "INVALID_REQUEST", "debug_id": "b1d1f06c7246c", "message": "Request is not well-formed, syntactically incorrect, or violates schema", "details": [ { "field": "/customer/country_code", "value": "USA", "location": "body", "issue": "INVALID_STRING_LENGTH", "description": "The value of a field is either too short or too long." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/payments/v2/#errors", "rel": "information_link", "method": "GET", "encType": "application/json" } ] }

{ "name": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "debug_id": "90bff07028f7f", "details": [ { "field": "/purchase_units/amount/currency_code", "value": "III", "issue": "INVALID_CURRENCY_CODE", "description": "Currency code is invalid. Please refer https://developer.paypal.com/docs/integration/direct/rest/currency-codes/ for list of supported currency codes." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/payments/v2/#errors", "rel": "information_link", "method": "GET" } ] }

Find a list of eligible payment methods.

200application/json

400application/json

422application/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Find a list of eligible payment methods.

200application/json

400application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`