Paypal Package

Accept PayPal and credit card payments online or on mobile.

• Domain: paypal.com
• Credentials: clientId, secret

How to get credentials:

1. Go to PayPal Developer Area
2. Log In or Sign up
3. Open your Dashboard
4. Create an app to receive REST API credentials for testing and live transactions.
5. Retrive your clientId and secret

Webhook credentials

Please use SDK to test this feature.

1. Go to RapidAPI
2. Log in or create an account
3. Go to My apps
4. Add new project with projectName to get your project Key

Custom datatypes:

Paypal.getAccessToken

Use the OAuth request to get an access token for use with your payments calls.

Paypal.createPayment

Use the payment resource for direct credit card payments, stored credit card payments, or PayPal account payments.

payer format:

{"payment_method": "paypal"}

transactions format:

[
{
  "amount": {
    "total": "30.11",
    "currency": "USD",
    "details": {
      "subtotal": "30.00",
      "tax": "0.07",
      "shipping": "0.03",
      "handling_fee": "1.00",
      "shipping_discount": "-1.00",
      "insurance": "0.01"
    }
  },
  "description": "This is the payment transaction description.",
  "custom": "EBAY_EMS_90048630024435",
  "invoice_number": "48787589673",
  "payment_options": {
    "allowed_payment_method": "INSTANT_FUNDING_SOURCE"
  },
  "soft_descriptor": "ECHI5786786",
  "item_list": {
    "items": [
      {
        "name": "hat",
        "description": "Brown color hat",
        "quantity": "5",
        "price": "3",
        "tax": "0.01",
        "sku": "1",
        "currency": "USD"
      },
      {
        "name": "handbag",
        "description": "Black color hand bag",
        "quantity": "1",
        "price": "15",
        "tax": "0.02",
        "sku": "product34",
        "currency": "USD"
      }
    ],
    "shipping_address": {
      "recipient_name": "Hello World",
      "line1": "4thFloor",
      "line2": "unit#34",
      "city": "SAn Jose",
      "country_code": "US",
      "postal_code": "95131",
      "phone": "011862212345678",
      "state": "CA"
    }
  }
}
]

redirectUrls format:

{
    "return_url": "http://www.amazon.com",
    "cancel_url": "http://www.hawaii.com"
}

Paypal.executePayment

Executes a PayPal payment that the payer has approved. You can optionally pass in one or more transactions to update transaction information when you execute the payment.

Paypal.getPayment

Shows details for a payment, by ID, that is yet completed. For example, a payment that was created, approved, or failed.

Paypal.updatePayment

Partially updates a payment, by ID. You cannot update a payment after the payment is executed.

items format:

[
    {
      "op": "replace",
      "path": "/transactions/0/amount",
      "value": {
        "total": "32.37",
        "currency": "USD",
        "details": {
          "subtotal": "30.00",
          "shipping": "2.37"
        }
      }
    },
    {
      "op": "add",
      "path": "/transactions/0/item_list/shipping_address",
      "value": {
        "recipient_name": "Gruneberg, Anna",
        "line1": "Kathwarinenhof 1",
        "city": "Flensburg",
        "postal_code": "24939",
        "country_code": "DE"
      }
    }
]

Paypal.getPaymentList

Lists payments that were created by the create payment call and are in any state. The list shows the payments that are made to the merchant who makes the call.

Paypal.getSale

Shows details for a sale transaction, by ID.

Paypal.refundSale

Refunds a completed payment.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

Paypal.getRefund

Shows details for a refund, by ID.

Paypal.getAuthorization

Use the getAuthorization method and related sub-resources to act on a previously created authorization. You can show details for, capture, void, and reauthorize an authorization.

Paypal.captureAuthorization

Use this resource to capture and process a previously created authorization.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

Paypal.voidAuthorization

Voids a previously authorized payment.

Paypal.reauthorizePayment

Reauthorizes a PayPal account payment. We recommend that you reauthorize a payment after the initial three-day honor period to ensure that funds are still available.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

Paypal.getCapture

Shows details for a captured payment, by ID.

Paypal.refundCapture

Refunds a captured payment, by ID.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

Paypal.getOrder

Shows details for an order, by ID.

Paypal.authorizeOrder

Authorizes an order, by ID.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

Paypal.captureOrder

Captures a payment on an order.

amount format:

{
    "total": "2.34",
    "currency": "USD"
}

transactionFee format:

{
    "value": "2.34",
    "currency": "USD"
}

Paypal.voidOrder

Voids an order, by ID.

Paypal.createPlan

You can create an empty billing plan and add a trial period and/or regular billing. Alternatively, you can create a fully loaded plan that includes both a trial period and regular billing.

paymentDefinitions format:

[
    {
      "name": "Regular Payments",
      "type": "REGULAR",
      "frequency": "MONTH",
      "frequency_interval": "2",
      "amount": {
        "value": "100",
        "currency": "USD"
      },
      "cycles": "12",
      "charge_models": [
        {
          "type": "SHIPPING",
          "amount": {
            "value": "10",
            "currency": "USD"
          }
        },
        {
          "type": "TAX",
          "amount": {
            "value": "12",
            "currency": "USD"
          }
        }
      ]
    }
]

merchantPreferences format:

{
    "setup_fee": {
      "value": "1",
      "currency": "USD"
    },
    "return_url": "http://www.return.com",
    "cancel_url": "http://www.cancel.com",
    "auto_bill_amount": "YES",
    "initial_fail_amount_action": "CONTINUE",
    "max_fail_attempts": "0"
}

Paypal.updatePlan

You can update the information for an existing billing plan. The state of a plan must be active before a billing agreement is created.

items format:

[
  {
    "path": "/",
    "value": {
      "state": "ACTIVE"
    },
    "op": "replace"
  }
]

Paypal.getPlan

Use this call to get details about a specific billing plan.

Paypal.getPlanList

Use this call to get a list of all billing plans based on their current state and optional query string parameters.

Paypal.createAgreement

Creates a billing agreement for the buyer.

payer format:

{
    "payment_method": "paypal"
}

plan format:

{
    "id": "P-94458432VR012762KRWBZEUA"
}

agreementDetails format:

{
    YOUR_AGREEMENT_DETAILS_JSON_OBJECT
}

shippingAddress format:

{
    "line1": "111 First Street",
    "city": "Saratoga",
    "state": "CA",
    "postal_code": "95070",
    "country_code": "US"
}

overrideChargeModels format:

{
    "id": "CHM-92S85978TN737850VRWBZEUA",
    "type": "TAX",
    "amount": {
      "currency": "USD",
      "value": "12"
    }
}

overrideMerchantPreferences format:

{
      "setup_fee": {
        "currency": "USD",
        "value": "1"
      },
      "max_fail_attempts": "0",
      "return_url": "http://www.return.com",
      "cancel_url": "http://www.cancel.com",
      "auto_bill_amount": "YES",
      "initial_fail_amount_action": "CONTINUE"
}

Paypal.executeAgreement

Executes an agreement after the buyer approves it.

Paypal.updateAgreement

Updates an agreement, by ID.

items format:

[
  {
    "op": "replace",
    "path": "/",
    "value": {
      "description": "New Description",
      "shipping_address": {
        "line1": "2065 Hamilton Ave",
        "city": "San Jose",
        "state": "CA",
        "postal_code": "95125",
        "country_code": "US"
      }
    }
  }
]

Paypal.getAgreement

Shows details for an agreement, by ID.

Paypal.suspendAgreement

Suspends an agreement, by ID.

amount format:

{
    "value": "2.34",
    "currency": "USD"
}

Paypal.reactivateAgreement

Reactivates an agreement, by ID.

amount format:

{
    "value": "2.34",
    "currency": "USD"
}

Paypal.cancelAgreement

Cancels an agreement, by ID.

amount format:

{
    "value": "2.34",
    "currency": "USD"
}

Paypal.getTransactionsForBillingAgreement

Lists transactions for a billing agreement.

Paypal.setAgreementBalance

Sets the outstanding amount of an agreement, by ID.

Paypal.billAgreementBalance

Bills the outstanding amount of an agreement, by ID.

amount format:

{
    "value": "2.34",
    "currency": "USD"
}

Paypal.createPayout

You can make payouts to one or more PayPal accounts.

senderBatchHeader format:

{
    "sender_batch_id": "325272063",
    "email_subject": "You have a Payout!"
}

items format:

[
    {
      "recipient_type": "EMAIL",
      "amount": {
        "value": "9.87",
        "currency": "USD"
      },
      "note": "Thanks for your patronage!",
      "sender_item_id": "201403140001",
      "receiver": "[email protected]"
    }
]

Paypal.getPayout

Periodically shows the latest status of a batch payout along with the transaction status and other data for individual items.

Paypal.getPayoutItem

Shows the details for a payout item. Use this call to review the current status of a previously unclaimed, or pending, payout item.

Paypal.cancelPayoutItem

Cancels an unclaimed transaction. If no one claims the unclaimed item within 30 days, the funds are automatically returned to the sender. Use this call to cancel the unclaimed item before the automatic 30-day refund.

Paypal.createCreditCard

Stores credit card details with PayPal.

billingAddress format:

{
    "line1":"111 First Street",
    "city":"Saratoga",
    "country_code":"US",
    "state":"CA",
    "postal_code":"95070"
}

Paypal.deleteCreditCard

Deletes details of a stored credit card. Include the credit card ID in the request URI.

Paypal.getCreditCard

Shows details for a stored credit card.

Paypal.getCreditCardList

Lists stored credit cards.

Paypal.updateCreditCard

Updates a stored credit card, by ID.

items format:

[
    {
      "op": "replace",
      "path": "/billing_address",
      "value": {
        "line1": "111 First Street",
        "city": "Saratoga",
        "country_code": "US",
        "state": "CA",
        "postal_code": "95070"
      }
    }
]

Paypal.createTokenFromAurhorizationCode

Updates a stored credit card, by ID.

Paypal.createTokenFromRefreshToken

Create an access token from a refresh token.

Paypal.getUser

Use this call to retrieve user profile attributes.

Paypal.createInvoice

Creates a draft invoice.

merchantInfo format:

{
    "email": "[email protected]",
    "first_name": "Dennis",
    "last_name": "Doctor",
    "business_name": "Medical Professionals, LLC",
    "phone": {
      "country_code": "001",
      "national_number": "5032141716"
    },
    "address": {
      "line1": "1234 Main St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97217",
      "country_code": "US"
    }
}

billingInfo format:

[
    {
      "email": "[email protected]"
    }
]

ccInfo format:

{
    "email": "[email protected]",
    "first_name": "Dennis",
    "last_name": "Doctor",
    "business_name": "Medical Professionals, LLC",
    "phone": {
      "country_code": "001",
      "national_number": "5032141716"
    },
    "address": {
      "line1": "1234 Main St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97217",
      "country_code": "US"
    }
}

shippingInfo format:

{
    "first_name": "Sally",
    "last_name": "Patient",
    "business_name": "Not applicable",
    "phone": {
      "country_code": "001",
      "national_number": "5039871234"
    },
    "address": {
      "line1": "1234 Broad St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97216",
      "country_code": "US"
    }
}

items format:

[
    {
      "name": "Sutures",
      "quantity": 100,
      "unit_price": {
        "currency": "USD",
        "value": "5"
      }
    }
]

paymentTerm format:

{
    "term_type": "NET_45"
}

discount format:

{
    "percent": "5"
}

shippingCost format:

{
    YOUR_SHIPPING_COST_JSON_OBJECT
}

custom format:

{
    YOUR_CUSTOM_JSON_OBJECT
}

minimumAmountDue format:

{
    YOUR_MINIMAL_AMOUNT_DUE_JSON_OBJECT
}

Paypal.sendInvoice

Sends an invoice, by ID, to a customer.

Paypal.updateInvoice

Updates an invoice, by ID.

merchantInfo format:

{
    "email": "[email protected]",
    "first_name": "Dennis",
    "last_name": "Doctor",
    "business_name": "Medical Professionals, LLC",
    "phone": {
      "country_code": "001",
      "national_number": "5032141716"
    },
    "address": {
      "line1": "1234 Main St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97217",
      "country_code": "US"
    }
}

billingInfo format:

[
    {
      "email": "[email protected]"
    }
]

ccInfo format:

{
    "email": "[email protected]",
    "first_name": "Dennis",
    "last_name": "Doctor",
    "business_name": "Medical Professionals, LLC",
    "phone": {
      "country_code": "001",
      "national_number": "5032141716"
    },
    "address": {
      "line1": "1234 Main St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97217",
      "country_code": "US"
    }
}

shippingInfo format:

{
    "first_name": "Sally",
    "last_name": "Patient",
    "business_name": "Not applicable",
    "phone": {
      "country_code": "001",
      "national_number": "5039871234"
    },
    "address": {
      "line1": "1234 Broad St.",
      "city": "Portland",
      "state": "OR",
      "postal_code": "97216",
      "country_code": "US"
    }
}

items format:

[
    {
      "name": "Sutures",
      "quantity": 100,
      "unit_price": {
        "currency": "USD",
        "value": "5"
      }
    }
]

paymentTerm format:

{
    "term_type": "NET_45"
}

discount format:

{
    "percent": "5"
}

shippingCost format:

{
    YOUR_SHIPPING_COST_JSON_OBJECT
}

custom format:

{
    YOUR_CUSTOM_JSON_OBJECT
}

minimumAmountDue format:

{
    YOUR_MINIMAL_AMOUNT_DUE_JSON_OBJECT
}

Paypal.getInvoice

Shows details for an invoice, by ID.

Paypal.getInvoiceList

Lists invoices that belong to the merchant who makes the call.

Paypal.generateInvoiceNumber

Generates the next invoice number that is available to the user.

Paypal.searchInvoice

Lists invoices that match search criteria.

lowerTotalAmount format:

{
    "currency": "USD",
    "value": "5"
}

upperTotalAmount format:

{
    "currency": "USD",
    "value": "5"
}

Paypal.sendInvoiceReminder

Sends a reminder to the payer that a payment is due for an invoice, by ID.

ccEmails format:

[
    "[email protected]"
]

Paypal.deleteInvoice

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only.

Paypal.getQRCode

Generates a QR code for an invoice, by ID.

Paypal.getTemplate

Shows details for a template, by ID.

Paypal.getTemplateList

Lists all merchant-created templates. The list shows the emails, addresses, and phone numbers from the merchant profile.

Paypal.createWebProfile

Creates a web experience profile.

flowConfig format:

{
  "landing_page_type": "billing",
  "bank_txn_pending_url": "http://www.ebay.com"
}

inputFields format:

{
  "no_shipping": 1,
  "address_override": 1
}

presentation format:

{
  "logo_image": "http://www.ebay.com"
}

Paypal.getWebProfile

Shows details for a web experience profile, by ID.

Paypal.getProfileWebList

Lists web experience profiles for a merchant.

Paypal.updateWebProfile

Updates a web experience profile, by ID.

flowConfig format:

{
  "landing_page_type": "billing",
  "bank_txn_pending_url": "http://www.ebay.com"
}

inputFields format:

{
  "no_shipping": 1,
  "address_override": 1
}

presentation format:

{
  "logo_image": "http://www.ebay.com"
}

Paypal.deleteWebProfile

Deletes a web experience profile, by ID.

Paypal.createWebhook

Subscribes your webhook listener to events.

eventTypes format:

[
    {
      "name": "PAYMENT.AUTHORIZATION.CREATED"
    },
    {
      "name": "PAYMENT.AUTHORIZATION.VOIDED"
    }
]

Paypal.getWebhook

Shows details for a webhook, by ID.

Paypal.getWebhookList

Lists all webhooks.

Paypal.updateWebhook

Updates a webhook, by ID. Supports only the replace operation.

items format:

[
  {
    "op": "replace",
    "path": "/url",
    "value": "http://www.ebay.com/paypal_webhook_new_url"
  },
  {
    "op": "replace",
    "path": "/event_types",
    "value": [
      {
        "name": "PAYMENT.SALE.REFUNDED"
      }
    ]
  }
]

Paypal.deleteWebhook

Deletes a webhook, by ID.

Paypal.getEventNotifications

Shows details for an event notification, by ID.

Paypal.getEventNotificationsList

Lists webhook event notifications. You can specify one or more optional query parameters to filter the response.

Paypal.resendEventNotification

Resends an event notification, by event ID.

Paypal.getEventList

Lists events to which an app can subscribe.

Paypal.getWebhookEventSubscriptionList

Lists the event subscriptions for a webhook, by ID.

Paypal.simulateWebhookEvent

Simulates a webhook event by using a sample payload.

Paypal.cancelSentInvoice

Cancels a sent invoice, by ID, and, optionally, sends a notification about the cancellation to the payer, merchant, and Cc: emails.

ccEmails format:

[
    "[email protected]"
]

Paypal.markInvoiceAsPaid

Marks an invoice, by ID, as paid.

amount format:

{
    "currency": "USD",
    "value": "20.00"
}

Paypal.markInvoiceAsRefunded

Marks an invoice, by ID, as refunded.

amount format:

{
    "currency": "USD",
    "value": "20.00"
}

Paypal.deleteExternalPayment

Deletes an external payment transaction, by ID, from an invoice, by ID.

Paypal.deleteExternalRefund

Deletes an external refund transaction, by ID, from an invoice, by ID.

Paypal.createTemplate

Creates an invoice template. When you create an invoice from a template, the invoice is populated with the predefined data that the source template contains.

templateData format:

{
    "items": [
      {
        "name": "Nutri Bullet",
        "quantity": 1,
        "unit_price": {
          "currency": "USD",
          "value": "50.00"
        }
      }
    ],
    "merchant_info": {
      "email": "[email protected]"
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Thank you for your business.",
    "logo_url": "https://pics.paypal.com/v1/images/redDot.jpeg"
}

settings format:

[
    {
      "field_name": "items.date",
      "display_preference": {
        "hidden": true
      }
    },
    {
      "field_name": "custom",
      "display_preference": {
        "hidden": true
      }
    }
]

Paypal.deleteTemplate

Deletes a template, by ID.

Paypal.verifyWebhookSignature

Verifies a webhook signature.

Paypal.updateTemplate

Updates a template, by ID. In the JSON request body, pass a complete template object. The update method does not support partial updates.

templateData format:

{
    "items": [
      {
        "name": "Nutri Bullet",
        "quantity": 1,
        "unit_price": {
          "currency": "USD",
          "value": "50.00"
        }
      }
    ],
    "merchant_info": {
      "email": "[email protected]"
    },
    "tax_calculated_after_discount": false,
    "tax_inclusive": false,
    "note": "Thank you for your business.",
    "logo_url": "https://pics.paypal.com/v1/images/redDot.jpeg"
}

settings format:

[
    {
      "field_name": "items.date",
      "display_preference": {
        "hidden": true
      }
    },
    {
      "field_name": "custom",
      "display_preference": {
        "hidden": true
      }
    }
]