Retrieve a setup token

API v3

SDK

Returns a readable representation of temporarily vaulted payment source associated with the setup token id.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

Permission to only read from vaulthttps://uri.paypal.com/services/vault/payment-tokens/read

Path Parameters

id*string

ID of the setup token.

Match^[0-9a-zA-Z_-]+$

Length7 <= length <= 36

Header Parameters

Content-Type?string

Specifies the request format.

Match^[A-Za-z0-9/+-]+$

Length1 <= length <= 255

Response Body

`application/json`

curl -X GET "https://api.paypal.com/v3/vault/v3/vault/setup-tokens/strings"

{
  "id": "string",
  "customer": {
    "id": "string",
    "merchant_customer_id": "string"
  },
  "status": "CREATED",
  "payment_source": {
    "card": {
      "name": "string",
      "last_digits": "stri",
      "brand": "VISA",
      "expiry": "strings",
      "billing_address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "admin_area_2": "string",
        "admin_area_1": "string",
        "postal_code": "string",
        "country_code": "st",
        "id": "string"
      },
      "verification_status": "VERIFIED",
      "verification": {
        "network_transaction_id": "string",
        "date": "stri",
        "network": "VISA",
        "time": "stringstringstringst",
        "amount": {
          "currency_code": "str",
          "value": "string"
        },
        "processor_response": {
          "avs_code": "A",
          "cvv_code": "E"
        },
        "three_d_secure": null
      },
      "network_transaction_reference": {
        "id": "stringstr",
        "date": "stri",
        "network": "VISA",
        "acquirer_reference_number": "string",
        "time": "stringstringstringst"
      },
      "authentication_result": {
        "three_d_secure": {
          "authentication_status": "Y",
          "enrollment_status": "Y",
          "authentication_id": "string"
        }
      },
      "bin_details": {
        "bin": "string",
        "issuing_bank": "string",
        "bin_country_code": "st",
        "products": [
          "string"
        ]
      },
      "type": "CREDIT"
    },
    "paypal": {
      "description": "string",
      "usage_pattern": "IMMEDIATE",
      "shipping": {
        "name": {
          "full_name": "string"
        },
        "email_address": "string",
        "phone_number": {
          "country_code": "str",
          "national_number": "string"
        },
        "type": "SHIPPING",
        "address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "admin_area_2": "string",
          "admin_area_1": "string",
          "postal_code": "string",
          "country_code": "st"
        }
      },
      "permit_multiple_payment_tokens": false,
      "usage_type": "MERCHANT",
      "customer_type": "CONSUMER",
      "email_address": "string",
      "payer_id": "stringstrings",
      "name": {
        "given_name": "string",
        "surname": "string"
      },
      "phone": {
        "phone_type": "FAX",
        "phone_number": {
          "national_number": "string"
        }
      },
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "admin_area_2": "string",
        "admin_area_1": "string",
        "postal_code": "string",
        "country_code": "st"
      },
      "account_id": "stringstrings",
      "phone_number": {
        "country_code": "str",
        "national_number": "string",
        "extension_number": "string"
      }
    },
    "venmo": {
      "description": "string",
      "usage_pattern": "IMMEDIATE",
      "shipping": {
        "name": {
          "full_name": "string"
        },
        "email_address": "string",
        "phone_number": {
          "country_code": "str",
          "national_number": "string"
        },
        "type": "SHIPPING",
        "address": {
          "address_line_1": "string",
          "address_line_2": "string",
          "admin_area_2": "string",
          "admin_area_1": "string",
          "postal_code": "string",
          "country_code": "st"
        }
      },
      "permit_multiple_payment_tokens": false,
      "usage_type": "MERCHANT",
      "customer_type": "CONSUMER",
      "email_address": "string",
      "payer_id": "stringstrings",
      "name": {
        "given_name": "string",
        "surname": "string"
      },
      "phone": {
        "phone_type": "FAX",
        "phone_number": {
          "national_number": "string"
        }
      },
      "address": {
        "address_line_1": "string",
        "address_line_2": "string",
        "admin_area_2": "string",
        "admin_area_1": "string",
        "postal_code": "string",
        "country_code": "st"
      },
      "user_name": "string"
    }
  },
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "links": [
        {
          "href": "string",
          "rel": "string",
          "method": "GET"
        }
      ],
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{ "id": "string", "customer": { "id": "string", "merchant_customer_id": "string" }, "status": "CREATED", "payment_source": { "card": { "name": "string", "last_digits": "stri", "brand": "VISA", "expiry": "strings", "billing_address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st", "id": "string" }, "verification_status": "VERIFIED", "verification": { "network_transaction_id": "string", "date": "stri", "network": "VISA", "time": "stringstringstringst", "amount": { "currency_code": "str", "value": "string" }, "processor_response": { "avs_code": "A", "cvv_code": "E" }, "three_d_secure": null }, "network_transaction_reference": { "id": "stringstr", "date": "stri", "network": "VISA", "acquirer_reference_number": "string", "time": "stringstringstringst" }, "authentication_result": { "three_d_secure": { "authentication_status": "Y", "enrollment_status": "Y", "authentication_id": "string" } }, "bin_details": { "bin": "string", "issuing_bank": "string", "bin_country_code": "st", "products": [ "string" ] }, "type": "CREDIT" }, "paypal": { "description": "string", "usage_pattern": "IMMEDIATE", "shipping": { "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "type": "SHIPPING", "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "permit_multiple_payment_tokens": false, "usage_type": "MERCHANT", "customer_type": "CONSUMER", "email_address": "string", "payer_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "account_id": "stringstrings", "phone_number": { "country_code": "str", "national_number": "string", "extension_number": "string" } }, "venmo": { "description": "string", "usage_pattern": "IMMEDIATE", "shipping": { "name": { "full_name": "string" }, "email_address": "string", "phone_number": { "country_code": "str", "national_number": "string" }, "type": "SHIPPING", "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" } }, "permit_multiple_payment_tokens": false, "usage_type": "MERCHANT", "customer_type": "CONSUMER", "email_address": "string", "payer_id": "stringstrings", "name": { "given_name": "string", "surname": "string" }, "phone": { "phone_type": "FAX", "phone_number": { "national_number": "string" } }, "address": { "address_line_1": "string", "address_line_2": "string", "admin_area_2": "string", "admin_area_1": "string", "postal_code": "string", "country_code": "st" }, "user_name": "string" } }, "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

{ "name": "string", "message": "string", "debug_id": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ], "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

Retrieve a setup token

200application/json

403application/json

404application/json

422application/json

500application/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

Retrieve a setup token

200application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`