Capture a PayPal Order

POST 
/api/paypal_orders/:orderId/capture

Captures an approved PayPal order and returns its status.

Request

Path Parameters

orderId stringrequired
The PayPal order ID to capture
Example: 6MR709191W4328148

Header Parameters

Unique-Request-Id string

Possible values: <= 50 characters

An optional unique identifier for the request, limited to 50 characters. Used to track requests and prevent duplication.

Responses

200

OK - The request was processed successfully.

application/json

Schema

Schema

captured booleanrequired

Example (from schema)

{
  "captured": true
}

401

Unauthorised -- Your access token is wrong.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

403

Forbidden -- Access to the requested resource or action is forbidden.

application/json

Schema

Schema

type string
title string
detail string

Example (from schema)

{
  "type": "string",
  "title": "string",
  "detail": "string"
}

Loading...