Immediate Capture
DocsLast updated: June 15th 2023, @ 5:00:00 pm
You can immediately capture money from your buyers and move it to your sellers.
Integration Steps
Before implementing immediate capture, you must complete Seller Onboarding and Checkout. Then, complete the following steps:
1. Create an order
Before you capture funds, you must create an order with the intent
field set to CAPTURE
.
- cURL
- Node
1curl -v -X POST https://api-m.sandbox.paypal.com/v2/checkout/orders2-H 'Content-Type: application/json'3-H 'Authorization: Bearer <Access-Token>'4-H 'PayPal-Partner-Attribution-Id: <BN-Code>'5-d '{6"intent": "CAPTURE",7"purchase_units": [{8"amount": {9 "currency_code": "USD",10 "value": "100.00"11},12"payee": {13 "email_address": "seller@example.com"14},15"payment_instruction": {16 "disbursement_mode": "INSTANT",17 "platform_fees": [{18 "amount": {19 "currency_code": "USD",20 "value": "25.00"21 }22 }]23}24}]25}'
- Use the
purchase_units/payee
object to specify the end receiver of the funds. - Use the
purchase_units/payment_instruction/disbursement_mode
field to specify when funds should be disbursed to the payee upon calling capture order. In this example, funds are disbursed immediately upon capture. To hold these funds, see the Delay Disbursements guide. - Use the
purchase_units/payment_instruction/platform_fees
array to specify fees for the order.
2. Capture an order
After your buyer approves the order, you call capture order to capture the buyer's funds.
- cURL
- Node
1curl -v -k -X POST https://api-m.paypal.com/v2/checkout/orders/5O190127TN364715T/capture2-H 'PayPal-Partner-Attribution-Id:'<BN-Code>'3-H 'Authorization: Bearer <Access-Token>'4-H 'Content-Type: application/json'5-d '{}'
Note: Orders cannot be captured until the status of the order is set to
APPROVED
. The order status is set toAPPROVED
when the buyer successfully completes the checkout flow.