How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PayPal

PayPal Payment-Tokens API

Use the `/vault/payment-tokens` resource to create, retrieve, and delete a payment token that may optionally be associated with a customer.

Documentation Provider Profile APIs.io OpenAPI GitHub

PayPal Payment-Tokens API is one of 37 APIs that PayPal publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Payment-Tokens. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 4 operations across 2 paths, and defines 53 schemas. It is described by OpenAPI 3.0.3, at version 1.6.

Requests are made against 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com.

4 operations 2 paths 53 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.6
Servers
https://api-m.sandbox.paypal.com
https://api-m.paypal.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

PayPal Payment-Tokens API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Oauth2) using the clientCredentials flow, exposing 1 scope.

  • Oauth2 — Oauth 2.0 authentication

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payment-Tokens 4

Use the /vault/payment-tokens resource to create, retrieve, and delete a payment token that may optionally be associated with a customer.

POST
/v3/vault/payment-tokens
Paypal Create payment token for a given payment source
payment-tokens.create 1 param body → 200201400403404422500
GET
/v3/vault/payment-tokens
Paypal List all payment tokens
customer.payment-tokens.get 4 params → 200400403500
GET
/v3/vault/payment-tokens/{id}
Paypal Retrieve a payment token
payment-tokens.get 1 param → 200403404422500
DELETE
/v3/vault/payment-tokens/{id}
Paypal Delete payment token
payment-tokens.delete 1 param → 204400403500

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are address_portable (10 properties), card (10 properties), card_response (7 properties), name (7 properties). Each schema is shown below with its type and property counts.

language
string
The [language tag](https://tools.ietf.org/html/bcp47section-2) for the language in which to localize the error-related strings, such as messages, issues, and s…
shipping_detail
object
The shipping details.
3 properties
phone_type
string
The phone type.
account_id
string
The account identifier for a PayPal account.
link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties 2 required
ach_debit_verification_status
string
The ach debit verification status.
date_no_time
string
The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). To represent special legal values, such as a date of…
ach_debit_response
customer
object
Customer in merchant's or partner's system of records.
1 property
card_brand
string
The card network or brand. Applies to credit, debit, gift, and payment cards.
card_request
A Resource representing a request to vault a Card.
payment_token_response
object
Full representation of a saved payment token.
4 properties
merchant_partner_customer_id
string
The unique ID for a customer generated by PayPal.
name
object
The name of the party.
7 properties
instrument_id
string
The identifier of the instrument.
metadata
customer_vault_payment_tokens_response
object
Collection of payment tokens saved for a given customer.
5 properties
phone
object
The phone number, in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
3 properties 2 required
processor_response
object
The processor information. Might be required for payment requests, such as direct credit card transactions.
4 properties
experience_context
object
Customizes the Vault creation flow experience for your customers.
6 properties
date_year_month
string
The year and month, in ISO-8601 YYYY-MM date format. See [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6).
vault_id
string
The PayPal-generated ID for the vault token.
3ds_result
phone_with_type
object
The phone information.
2 properties 1 required
venmo_response
object
Full representation of a Venmo Payment Token.
address_entity
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties 2 required
token_id_request
object
The Tokenized Payment Source representing a Request to Vault a Token.
3 properties 2 required
card_response
object
Full representation of a Card Payment Token.
7 properties
apple_pay_card
object
The payment card to be used to fund a payment. Can be a credit or debit card.
address_portable
object
The portable international postal address. Maps to [AddressValidationMetadata](https://github.com/googlei18n/libaddressinput/wiki/AddressValidationMetadata) an…
10 properties 1 required
paypal_wallet_response
object
Full representation of a PayPal Payment Token.
error
object
The error details.
6 properties 3 required
card_verification_details
object
Card Verification details including the authorization details and 3D SECURE details.
5 properties
ach_debit_response-2
A Resource representing a response of vaulted a ACH Debit Account.
currency_code
string
The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.
token_attributes
card
object
The payment card to use to fund a payment. Can be a credit or debit card.
10 properties
payer_base
object
The customer who approves and pays for the order. The customer is also known as the payer.
2 properties
country_code
string
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 a…
payment_token_request
object
Payment Token Request where the source defines the type of instrument to be stored.
3 properties 1 required
error_details-2
object
The error details. Required for client-side 4XX errors.
5 properties 1 required
apple_pay_payment_token_response
object
A resource representing a response for Apple Pay.
1 property
date_time
string
The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). Seconds are required while fractional seconds are option…
card_verification_method
string
The verification method of the card.
vault_instruction
string
Vault Instruction on action to be performed after a successful payer approval.
card_verification_status
string
Verification status of Card.
card_type
string
Type of card. i.e Credit, Debit and so on.
email
string
The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accep…
wallet_base
object
Resource consolidating common request and response attributes for vaulting a Digital Wallet.
5 properties
tax_info
object
The tax ID of the customer. The customer is also known as the payer. Both taxid and taxidtype are required.
2 properties 2 required
payer
object
The customer who approves and pays for the order. The customer is also known as the payer.
bank_response
object
Full representation of a Bank Payment Token.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-payment-tokens-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

PayPal Activate API
AE Profile APIs.io
PayPal Authorizations API
AE Profile APIs.io
PayPal Balances API
AE Profile APIs.io
PayPal Billing API
AE Profile APIs.io
PayPal Cancel API
AE Profile APIs.io
PayPal Capture API
AE Profile APIs.io
PayPal Captures API
AE Profile APIs.io
PayPal Deactivate API
AE Profile APIs.io
PayPal Disputes-Actions API
AE Profile APIs.io
PayPal Disputes API
AE Profile APIs.io
PayPal Invoices API
AE Profile APIs.io
PayPal Orders API
AE Profile APIs.io
#Payment-Tokens
← Back to P APIs
API Details
ID
paypal:paypal-payment-tokens-api
Server
https://api-m.sandbox.paypal.com
Docs
https://developer.paypal.com/docs/api/subscriptions/v1/
Provider
PayPal
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paypal-payment-tokens-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paypal-payment-tokens-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PayPal Payment-Tokens API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.