PayPal · Example Payload

Paypal Setup Tokenscreate Example

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Paypal Setup Tokenscreate Example is an example object payload from PayPal, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "setup-tokens.create",
  "method": "POST",
  "path": "/v3/vault/setup-tokens",
  "summary": "Paypal Create a setup token",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "setup_token_request",
      "example": {
        "payment_source": {
          "card": {
            "number": "4111111111111111",
            "expiry": "2027-02",
            "name": "John Doe",
            "billing_address": {
              "address_line_1": "2211 N First Street",
              "address_line_2": "17.3.160",
              "admin_area_1": "CA",
              "admin_area_2": "San Jose",
              "postal_code": "95131",
              "country_code": "US"
            },
            "experience_context": {
              "brand_name": "YourBrandName",
              "locale": "en-US",
              "return_url": "https://example.com/returnUrl",
              "cancel_url": "https://example.com/cancelUrl"
            }
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "setup_token_response",
      "example": {
        "id": "5C991763VB2781612",
        "customer": {
          "id": "customer_4029352050"
        },
        "status": "APPROVED",
        "payment_source": {
          "card": {
            "last_digits": "1111",
            "expiry": "2027-02",
            "name": "John Doe",
            "billing_address": {
              "address_line_1": "2211 N First Street",
              "address_line_2": "17.3.160",
              "admin_area_1": "CA",
              "admin_area_2": "San Jose",
              "postal_code": "95131",
              "country_code": "US"
            }
          }
        },
        "links": [
          {
            "rel": "self",
            "href": "https://api-m.paypal.com/v3/vault/setup-tokens/5C991763VB2781612",
            "method": "GET",
            "encType": "application/json"
          },
          {
            "rel": "confirm",
            "href": "https://api-m.paypal.com/v3/vault/payment-token",
            "method": "POST",
            "encType": "application/json"
          }
        ]
      }
    },
    {
      "status": "201",
      "contentType": "application/json",
      "name": "setup_token_response",
      "example": {
        "id": "5C991763VB2781612",
        "customer": {
          "id": "customer_4029352050"
        },
        "status": "APPROVED",
        "payment_source": {
          "card": {
            "last_digits": "1111",
            "expiry": "2027-02",
            "name": "John Doe",
            "billing_address": {
              "address_line_1": "2211 N First Street",
              "address_line_2": "17.3.160",
              "admin_area_1": "CA",
              "admin_area_2": "San Jose",
              "postal_code": "95131",
              "country_code": "US"
            }
          }
        },
        "links": [
          {
            "rel": "self",
            "href": "https://api-m.paypal.com/v3/vault/setup-tokens/5C991763VB2781612",
            "method": "GET",
            "encType": "application/json"
          },
          {
            "rel": "confirm",
            "href": "https://api-m.paypal.com/v3/vault/payment-token",
            "method": "POST",
            "encType": "application/json"
          }
        ]
      }
    }
  ]
}