2006
Table Of Contents
- Authorization & Capture Integration Guide
- Preface
- Overview
- Basic Authorization & Capture on the PayPal Website
- Authorization & Capture API
- Order Authorizations Scenarios
- Best Practices
- Testing PayPal Authorization & Capture
- PayPal Authorization & Capture Statuses
- PayPal Authorization & Capture API Error Codes, Short Messages, and Long Messages
- IPN and PayPal Authorization & Capture
- Glossary
Web Services API Reference June 2006 29
Authorization & Capture API
DoCapture
DoCaptureRequest
Request to capture funds from a PayPal member’s account.
Fields
T
ABLE 3.4 DoCaptureRequest Fields
Element Description Data Type Allowable Values Required?
Authorization
ID
The authorization identification number of the
payment you want to capture. This can be an order
number, an order authorization number, or a
rauthorization number.
Character length and limits: 19 single-byte
characters maximum
xs:string
See description. Yes
Amount
Amount to capture.
Limitations: Must not exceed $10,000 USD in any
currency. No currency symbol. Decimal separator
must be a period (.), and the thousands separator
must be a comma (,).
ebl:BasicAmount
Type
See description. Yes
CompleteType
Indicates if this capture is the last capture you intend
to make. The default is
Complete.
NOTE: If CompleteType is Complete, any remaining
amount of the original reauthorized
transaction is automatically voided.
Character length and limits: 12 single-byte
alphanumeric characters
ebl:Complete
CodeType
Default:
Complete
NotComplete
Yes
InvoiceID
Your invoice number or other identification
number.
NOTE: The InvoiceID value is recorded only if the
authorization you are capturing is an order
authorization, not a basic authorization.
Character length and limits: 127 single-byte
alphanumeric characters
xs:string See description. No
Note
An informational note about this settlement that is
displayed to the payer in email and in his transaction
history.
Character length and limits: 255 single-byte
characters
xs:string
See description. No