PayPal

Accept payments, manage catalog products, and automate billing with PayPal.

Collect (capture) the payment for an approved PayPal order.

Parameters

Parameter	Type	Required	Description
`order_id`	string	Yes	The ID of the order to collect payment for

Response

{}

Create a PayPal checkout order ready for buyer approval.

Parameters

Parameter	Type	Required	Description
`amount`	number	Yes	Order amount
`currency`	string	Yes	Currency code (e.g. USD)
`description`	string	No	Order description

Response

{}

Create a recurring billing plan for a PayPal product.

Parameters

Parameter	Type	Required	Description
`product_id`	string	Yes	The ID of the PayPal product this plan is for
`name`	string	Yes	Plan name
`interval_unit`	string	Yes	How often to bill, such as DAY, WEEK, MONTH, or YEAR
`interval_count`	number	Yes	How many units between each charge. For example, 3 with MONTH bills every 3 months.
`currency`	string	Yes	Billing currency
`amount`	number	Yes	Recurring charge amount

Response

{}

Add a product to your PayPal catalog so it can be used in billing plans.

Parameters

Parameter	Type	Required	Description
`name`	string	Yes	Product name
`description`	string	No	Product description
`category`	string	No	Product category, for example SOFTWARE

Response

{}

Look up the current status and details of a PayPal order.

Parameters

Parameter	Type	Required	Description
`order_id`	string	Yes	The ID of the order to look up

Response

{}

Issue a partial or full refund for a captured PayPal payment.

Parameters

Parameter	Type	Required	Description
`capture_id`	string	Yes	The ID of the captured payment to refund
`amount`	number	No	Amount to refund. Leave blank to refund the full amount.
`currency`	string	No	Currency code for the refund (e.g. USD). Required when you enter an amount.

Response

{}