Financing Options/
PayPal Credit Options

PayPal Credit financing options

DOCS

Last updated: Sept 24th, 12:36am

PayPal Credit is an open-ended credit account through PayPal that provides your buyers resusable credit lines. You display these options to your buyers on banners or during the checkout flow.

Know before you code

  • You must have a PayPal Credit product integrated into your branded platform.
  • This integration sets up financing options using the Credit Financing Options API.
  • Complete the steps in Get started to get the following sandbox account information from the Developer Dashboard:
    • Your client ID
    • Your personal and business sandbox accounts
  • Use your client ID when adding credit options to your website. Use your sandbox accounts when testing the options.
  • (UK merchants) Credit is a regulated activity in the UK. Before integrating a PayPal Credit button, you must be authorized to act as a credit broker and have a credit agreement with PayPal. For more information, contact business customer support through paypal.com or by calling 0800 358 7929.

1. List active options

To present available PayPal Credit financing options on banners, set the path query location to get details on active options.

Sample request

API endpoint used: Get currently active financing options

    1curl -v -X GET https://api-m.sandbox.paypal.com/v1/credit/active-merchant-financing-options?country_code=US \
    2  -H "Content-Type: application/json" \
    3  -H "Authorization: Bearer <Access-Token>"

    Modify the code

    After you copy the code in the sample request, modify the following:

    • Change Access-Token to your access token.
    • Update the country code in the endpoint's query parameter so that it reflects the needed country: US, GB, DE.

    Step result

    A successful request results in the following:

    • A return status code of HTTP 200 OK.
    • A JSON response body that contains the details for each active option available:
      • The credit financing ID
      • The term, in months
      • The country where this option is offered
      • The credit type includes the annual percentage rate (APR)
      • The ID for the accounts-receivable vendor
      • The minimum qualifying purchase amount for this option
      • Whether PayPal subsidizes the option
      • The related HATEOAS links
      • The date and time when the financing options are no longer active or valid

    Sample response

      1{
      2  "items": [{
      3    "options": [{
      4      "credit_financing": {
      5        "financing_code": "OBNY73JDEZ",
      6        "term": 6,
      7        "country_code": "US",
      8        "credit_type": "SAC",
      9        "vendor_financing_id": "PAY3306S",
      10        "enabled": true,
      11        "links": [
      12        {
      13          "href": "v1/credit/credit-financing/OBNY73JDEZ",
      14          "rel": "self",
      15          "method": "GET"
      16        }]
      17      },
      18      "min_amount": {
      19        "currency_code": "USD",
      20        "value": "99.00"
      21      },
      22      "paypal_subsidy": true
      23    },
      24    {
      25      "credit_financing": {
      26        "financing_code": "V4HPQCTEMB",
      27        "apr": "9.99",
      28        "nominal_rate": "9.9900",
      29        "term": 9,
      30        "country_code": "US",
      31        "credit_type": "INST",
      32        "vendor_financing_id": "PAYM309I",
      33        "enabled": true,
      34        "links": [
      35        {
      36          "href": "v1/credit/credit-financing/V4HPQCTEMB",
      37          "rel": "self",
      38          "method": "GET"
      39        }]
      40      },
      41      "min_amount": {
      42        "currency_code": "USD",
      43        "value": "199.99"
      44      },
      45      "paypal_subsidy": false
      46    }],
      47    "active_until_date_time": "2020-12-31T17:00:00Z"
      48  }]
      49}

      2. Calculate options

      To display PayPal Credit financing options to your buyers during the checkout flow, calculate the financing options based on location.

      Sample request

      API endpoint used: Calculate financing options available for a transaction

        1curl -v -X POST https://api-m.sandbox.paypal.com/v1/credit/calculated-financing-options \
        2  -H "Content-Type: application/json" \
        3  -H "Authorization: Bearer <Access-Token>" \
        4  -d '{
        5  "credit_product_identifiers": ["PPC_US_V2"],
        6  "transaction_amount": {
        7    "value": "999.99",
        8    "currency_code": "USD"
        9  },
        10  "tracking_id": "EC-3GY56644419521944"
        11}'

        Modify the code

        After you copy the code in the sample request, modify the following:

        • Change Access-Token to your access token.
        • Replace the value for the PayPal Credit product in credit_product_identifiers so that it reflects the right country: PPC_US_V2, PP_UK_PPC, or PP_DE_PPC.
        • Update the currency_code so that it reflects the right currency: USD, GBP, EUR.
        • The transaction_amount.
        • (Optional) Add a tracking_id to help with us with debugging in the case of an error.

        Step result

        • A return status code of HTTP 200 OK.
        • A JSON response body that contains the calculated options details:
          • Advertised APR
          • Nominal interest rate
          • Monthly payment amount
          • Total interest

        Sample response

          1{
          2  "configuration_owner_account": "X3RPJVPHPC7N8",
          3  "financing_fee_charged_to_separate_account": false,
          4  "financing_options": [{
          5    "qualifying_credit_options": [{
          6      "credit_financing": {
          7        "financing_code": "OBNY73JDEZ",
          8        "term": 6,
          9        "country_code": "US",
          10        "credit_type": "SAC",
          11        "vendor_financing_id": "PAY3306S",
          12        "enabled": true,
          13        "links": [
          14        {
          15          "href": "v1/credit/credit-financing/OBNY73JDEZ",
          16          "rel": "self",
          17          "method": "GET"
          18        }]
          19      },
          20      "min_amount": {
          21        "currency_code": "USD",
          22        "value": "9.99"
          23      },
          24      "total_cost": {
          25        "currency_code": "USD",
          26        "value": "9.99"
          27      },
          28      "paypal_subsidy": true
          29    },
          30    {
          31      "credit_financing": {
          32        "financing_code": "2S5JR3NOOR",
          33        "apr": "12.99",
          34        "nominal_rate": "12.9900",
          35        "term": 12,
          36        "country_code": "US",
          37        "credit_type": "INST",
          38        "vendor_financing_id": "PAYN312I",
          39        "enabled": true,
          40        "links": [
          41        {
          42          "href": "v1/credit/credit-financing/2S5JR3NOOR",
          43          "rel": "self",
          44          "method": "GET"
          45        }]
          46      },
          47      "min_amount": {
          48        "currency_code": "USD",
          49        "value": "5.99"
          50      },
          51      "monthly_percentage_rate": "0.01083",
          52      "monthly_payment": {
          53        "currency_code": "USD",
          54        "value": "0.90"
          55      },
          56      "total_interest": {
          57        "currency_code": "USD",
          58        "value": "0.84"
          59      },
          60      "total_cost": {
          61        "currency_code": "USD",
          62        "value": "10.83"
          63      },
          64      "paypal_subsidy": false
          65    }],
          66    "non_qualifying_credit_options": [{
          67      "credit_financing": {
          68        "financing_code": "V4HPQCTEMB",
          69        "apr": "9.99",
          70        "nominal_rate": "9.9900",
          71        "term": 9,
          72        "country_code": "US",
          73        "credit_type": "INST",
          74        "vendor_financing_id": "PAYM309I",
          75        "enabled": true,
          76        "links": [
          77        {
          78          "href": "v1/credit/credit-financing/V4HPQCTEMB",
          79          "rel": "self",
          80          "method": "GET"
          81        }]
          82      },
          83      "min_amount": {
          84        "currency_code": "USD",
          85        "value": "10.99"
          86      },
          87      "monthly_percentage_rate": "0.8325",
          88      "monthly_payment": {
          89        "currency_code": "USD",
          90        "value": "1.16"
          91      },
          92      "total_interest": {
          93        "currency_code": "USD",
          94        "value": "0.43"
          95      },
          96      "total_cost": {
          97        "currency_code": "USD",
          98        "value": "10.42"
          99      },
          100      "paypal_subsidy": false
          101    }]
          102  }]
          103}

          Additional information

          ReferencePayPal.comPrivacyCookiesSupportLegalContact

          Wenn Sie Cookies akzeptieren, verwenden wir diese, um Ihre Erfahrung zu verbessern und anzupassen und unseren Partnern zu ermöglichen, Ihnen personalisierte PayPal-Anzeigen zu zeigen, wenn Sie andere Websites besuchen. Cookies verwalten und mehr erfahren