Skip to content
Docs
Open Backstage
Operation

Capture an approved PayPal payment

POST/payments/{paymentId}/paypal/capture
Captures the PayPal order behind a payment once the buyer has approved it: what the PayPal JS SDK's onApprove callback asks for. A capture PayPal completes pays the order down the same path every processor's success takes; one it holds is answered 'pending' and settles when PayPal says so; one it declines fails the payment. Capturing again is safe: an order PayPal has captured already is read, not captured twice, and a payment that has succeeded answers as it is. When PayPal declines the funding source the buyer chose, the answer is 400 PAYPAL_INSTRUMENT_DECLINED and the payment stays capturable: restart the buttons so they can choose another. Needs payments.create, or orders.pay.

Path parameters

paymentIdstringRequired
Payment ID

Headers

X-Ticketlayer-ChannelstringOptional
Slug of the sales channel to act through. A channel-scoped credential supplies its own channel and this header, when sent, must agree with it. On a read it filters to what that channel sells, at its resolved prices; on a cart it is required; on an order operation it is derived from the order and may only confirm it, never contradict it.
Idempotency-KeystringOptional
Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.

Returns

The capture

Errors

400
Bad Request - Invalid input
401
Unauthorized - Authentication required
403
Forbidden - Insufficient permissions
404
Not Found - Resource not found
500
Internal Server Error

Every error names its code and links to it. All error codes

curl -X POST "https://api.ticketlayer.com/v1/payments/pay_abc123xyz789/paypal/capture" \  -H "Authorization: Bearer tlak_..." \  -H "X-Ticketlayer-Org: your-org-slug"
Response 200
{
  "capture": {
    "paymentId": "pay_abc123xyz789",
    "status": "succeeded",
    "captureId": "3C679366HH908993F",
    "reason": null,
    "orderId": "ord_abc123",
    "orderStatus": "confirmed"
  }
}

Try it in test mode

Path parameters
Payment ID