Find a list of eligible payment methods.

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

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Permission to do any real time payment, with support for sale/authorize/order intentshttps://uri.paypal.com/services/payments/realtimepayment
Permission to get information about payment readiness.https://uri.paypal.com/services/payments/payments-ready
Permission to call PaymentsReady via BrainTree SDK.Braintree:PaymentsReady
Permission to get information about merchant's eligible payment methods.https://uri.paypal.com/services/payments/client-payments-eligibility

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerobject<find_eligible_methods_request_customer>Optional

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

find_eligible_methods_request_customer properties

5 properties

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

channelobject<find_eligible_methods_request_customer_channel>Optional

Channel through which the request is being posted.

idstringOptional

The unique ID for a customer in merchant's or partner's system of records.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 36

emailstring<email_address>Optional

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

Match^(?:[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-Za-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+[A-Za-z0-9](?:[A-Za-z0-9-]*[A-Za-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-Za-z0-9-]*[A-Za-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5a\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])$Length3 <= length <= 254

phoneobject<phone-2>Optional

The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

purchase_unitsobject<eligibility_purchase_unit_request>[]Optional

Array of purchase units.

Items1 <= length <= 10

preferencesobject<find_eligible_methods_request_preferences>Optional

Preferences of merchant/partner consuming the API.

Response Body

`application/json`

curl -X POST "https://example.com/v2/payments/find-eligible-methods" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "User-Agent: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405" \  -H "PayPal-Client-Metadata-Id: 1295065d-6f34-42dc-ac65-fac0c86af250" \  -H "Content-Type: application/json" \  -d '{    "customer": {      "country_code": "US",      "channel": {        "browser_type": "SAFARI",        "device_type": "MOBILE",        "client_os": "IOS"      }    },    "purchase_units": [      {        "amount": {          "currency_code": "USD",          "value": "100.00"        }      }    ],    "preferences": {      "payment_source_constraint": {        "constraint_type": "EXCLUDE",        "payment_sources": [          "PAYPAL"        ]      }    }  }'

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

Find a list of eligible payment methods.

API v2

API v1

SDK

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

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Permission to do any real time payment, with support for sale/authorize/order intentshttps://uri.paypal.com/services/payments/realtimepayment
Permission to get information about payment readiness.https://uri.paypal.com/services/payments/payments-ready
Permission to call PaymentsReady via BrainTree SDK.Braintree:PaymentsReady
Permission to get information about merchant's eligible payment methods.https://uri.paypal.com/services/payments/client-payments-eligibility

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

customerobject<find_eligible_methods_request_customer>Optional

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

find_eligible_methods_request_customer properties

5 properties

country_codestring<country_code-2>Optional

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Length2 <= length <= 2

channelobject<find_eligible_methods_request_customer_channel>Optional

Channel through which the request is being posted.

idstringOptional

The unique ID for a customer in merchant's or partner's system of records.

Match^[0-9a-zA-Z_-]+$Length1 <= length <= 36

emailstring<email_address>Optional

The internationalized email address.

Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accepted maximum length for an email address is 254 characters. The pattern verifies that an unquoted @ sign exists.

phoneobject<phone-2>Optional

The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).

purchase_unitsobject<eligibility_purchase_unit_request>[]Optional

Array of purchase units.

Items1 <= length <= 10

preferencesobject<find_eligible_methods_request_preferences>Optional

Preferences of merchant/partner consuming the API.

Response Body

`application/json`

curl -X POST "https://example.com/v2/payments/find-eligible-methods" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "User-Agent: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405" \  -H "PayPal-Client-Metadata-Id: 1295065d-6f34-42dc-ac65-fac0c86af250" \  -H "Content-Type: application/json" \  -d '{    "customer": {      "country_code": "US",      "channel": {        "browser_type": "SAFARI",        "device_type": "MOBILE",        "client_os": "IOS"      }    },    "purchase_units": [      {        "amount": {          "currency_code": "USD",          "value": "100.00"        }      }    ],    "preferences": {      "payment_source_constraint": {        "constraint_type": "EXCLUDE",        "payment_sources": [          "PAYPAL"        ]      }    }  }'

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

Find a list of eligible payment methods.

find_eligible_methods_request_customer properties

find_eligible_methods_request_customer_channel properties

phone-2 properties

eligibility_purchase_unit_request properties

amount_with_breakdown properties

amount_breakdown properties

money properties

money properties

money properties

money properties

money properties

money properties

discount_with_breakdown properties

payee properties

find_eligible_methods_request_preferences properties

Payment Source Constraint properties

200application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

Eligible Payment Methods - Exclude listed payment methods

Eligible Payment Methods for a customer who is purchasing from multiple sellers

Eligible Payment Methods with User-Agent header

Eligible Payment Methods without payment token information

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Eligible Payment Methods - with payment tokens

On this page

On this page

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.

find_eligible_methods_request_customer properties

find_eligible_methods_request_customer_channel properties

phone-2 properties

eligibility_purchase_unit_request properties

amount_with_breakdown properties

amount_breakdown properties

money properties

money properties

money properties

money properties

money properties

money properties

discount_with_breakdown properties

payee properties

find_eligible_methods_request_preferences properties

Payment Source Constraint properties

200application/json

400application/json

401application/json

403application/json

422application/json

500application/json

defaultapplication/json

Eligible Payment Methods - Exclude listed payment methods

Eligible Payment Methods for a customer who is purchasing from multiple sellers

Eligible Payment Methods with User-Agent header

Eligible Payment Methods without payment token information

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Customer recognition using customer email and phone number

Eligible Payment Methods - with payment tokens

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`