Back-Office Administration

This section gives you examples of the following functions:

l	“Capturing, Authorizing, Voiding, and Reauthorizing”

l	“Refunding Using RefundTransaction”

l	“Searching for Transactions Using TransactionSearch”

l	“Viewing Details of a Single Transaction Using GetTransactionDetails”

Capturing, Authorizing, Voiding, and Reauthorizing

There are four APIs related to authorization and capture:

l

DoCapture

l	DoAuthorization

l

DoVoid

l	DoReauthorization

Making a Single Capture Using DoCapture

To capture only once, set the authorization identification number and the amount on DoCapture.

IMPORTANT:

Capturing only once is default. To be explicit, you can set COMPLETETYPE=Complete. COMPLETETYPE=Complete closes all outstanding authorizations for the order. You can not make anymore captures.

Table 6.1

Capturing the Full Amount of an Authorization

Request

[requiredSecurityParameters]&METHOD=DoCapture&AUTHORIZATIONID=01987219673867 &AMT=99.12&COMPLETETYPE=Complete

Response

[successResponseFields]&AUTHORIZATIONID=01987219673867 &TRANSACTIONID=7JZ9679864YA2699519&PARENTTRANSACTIONID=01987219673867 &RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=express‑checkout &PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=99.12 &CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed &PENDINGREASON=None&REASONCODE=None

Making Multiple Partial Captures Using DoCapture

You can capture a partial amount of an authorization by setting COMPLETETYPE=NotComplete

On the final capture, set COMPLETETYPE=Complete or do not specify COMPLETETYPE.

This example shows three captures:

l	The first two are partial captures. COMPLETETYPE is set to NotComplete

l	The last capture is for the full remaining amount. COMPLETETYPE is set to Complete.

Table 6.2

Capturing A Partial Amount of an Authorization

First Partial Capture Request

[requiredSecurityParameters]&METHOD=DoCapture&AUTHORIZATIONID=4EL6476506322203 &AMT=112.00&COMPLETETYPE=NotComplete

Response

[successResponseFields]&AUTHORIZATIONID=4EL6476506322203 &TRANSACTIONID=4Y117666R06578920&PARENTTRANSACTIONID=4EL6476506322203 &RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept &PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:23:15Z&AMT=112.00 &CURRENCYCODE=USD&FEEAMT=3.55&TAXAMT=0.00&PAYMENTSTATUS=Completed &PENDINGREASON=None&REASONCODE=None

Second Partial Capture Request

[requiredSecurityParameters]&METHOD=DoCapture&AUTHORIZATIONID=4EL6476506322203 &AMT=103.12&COMPLETETYPE=NotComplete

Response

[successResponseFields]&AUTHORIZATIONID=4EL6476506322203 &TRANSACTIONID=7JY48864YA2699519&PARENTTRANSACTIONID=4EL6476506322203 &RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept &PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=103.12 &CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed &PENDINGREASON=None&REASONCODE=None

Final Capture Request

[requiredSecurityParameters]&METHOD=DoCapture&AUTHORIZATIONID=4EL6476506322203 &AMT=103.12&COMPLETETYPE=Complete

Response

[successResponseFields]&AUTHORIZATIONID=4EL6476506322203 &TRANSACTIONID=7JZ89864YA2699519&PARENTTRANSACTIONID=4EL6476506322203 &RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept &PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=90.80 &CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed &PENDINGREASON=None&REASONCODE=None

Including an Invoice Number and Note on the Capture Using DoCapture

Whether the capture is for the full or a partial amount, you can include a note about the capture and your own invoice or other identification number.

Table 6.3

Including an Invoice Number and Note on a Capture

Request

[requiredSecurityParameters]&METHOD=DoCapture&AUTHORIZATIONID=4EL6476506322203 &COMPLETETYPE=Complete&AMT=304.92&INVNUM=H091234&NOTE=UPS+trk#+b86283978

Response

[successResponseFields]&AUTHORIZATIONID=4EL6476506322203 &TRANSACTIONID=7JZ89864YA2694419&PARENTTRANSACTIONID=4EL6476506322203 &RECEIPTID=5151-0525-2028-5336&TRANSACTIONTYPE=webaccept &PAYMENTTYPE=instant&ORDERTIME=2006-08-15T17:31:38Z&AMT=304.92 &CURRENCYCODE=USD&FEEAMT=3.29&TAXAMT=0.00&PAYMENTSTATUS=Completed &PENDINGREASON=None&REASONCODE=None

Refunding Using RefundTransaction

With RefundTransaction, you can refund the full amount or a partial amount of a transaction. Specify the original transaction ID and the refund type: Full or Partial.

Note:

If you do not have the transaction ID for the refund, you can credit the customer’s account without it using the DoNonReferencedCredit API. You must be approved by PayPal to use the DoNonReferencedCredit API. See your PayPal Account Manager for more information.

Full Refund

IMPORTANT:

If you refund the full amount, do not set the AMT field.

Table 6.4

Refunding the Full Amount of a Transaction

Request

[requiredSecurityParameters]&METHOD=RefundTransaction& TRANSACTIONID=019454569673867&REFUNDTYPE=Full

Response

[successResponseFields]&REFUNDTRANSACTIONID=4RP55200GJ177180N &FEEREFUNDAMT=4.01&GROSSREFUNDAMT=127.87&NETREFUNDAMT=123.86

Partial Refunds

To refund a partial amount, set REFUNDTYPE to Partial and set the AMT.

Table 6.5

Refunding A Partial Amount

Request

[requiredSecurityParameters]&METHOD=RefundTransaction &TRANSACTIONID=9CX07910UV614511L&REFUNDTYPE=Partial&AMT=12.95

Response

[successResponseFields]&REFUNDTRANSACTIONID=1H0011898K637700R &FEEREFUNDAMT=0.38&GROSSREFUNDAMT=12.95&NETREFUNDAMT=12.57

Including a Note with the Refund

Whether the refund is full or partial, you can also include a note about the refund.

Table 6.6

Including a Note with the Refund

Request

[requiredSecurityParameters]&METHOD=RefundTransaction& TRANSACTIONID=019454569673867&REFUNDTYPE=Partial&AMT=12.95& NOTE=Customer+changed+mind.

Response

[successResponseFields]&REFUNDTRANSACTIONID=1H0011898K637700R &FEEREFUNDAMT=0.38&GROSSREFUNDAMT=12.95&NETREFUNDAMT=12.57

Searching for Transactions Using TransactionSearch

To find all transactions that occurred on a particular date, use TransactionSearch and set the STARTDATE field to the date you desire. The date must be in UTC/GMT format

.

Table 6.7

Searching for Transactions by STARTDATE

Request

[requiredSecurityParameters]&METHOD=TransactionSearch &STARTDATE=2006-08-15T17:00:00Z

Respons

[successResponseFields]&L_TIMESTAMP0=2006-08-18T05:58:41Z& L_TIMEZONE0=GMT&L_TYPE0=Authorization&L_NAME0=John+Doe& L_TRANSACTIONID0=3XK029742B016373C&L_STATUS0=Pending&L_AMT0=1.00& L_TIMESTAMP1=2006-08-18T05:56:20Z&L_TIMEZONE1=GMT&L_TYPE1=Payment& L_NAME1=John+Doe&L_TRANSACTIONID1=4BV19600WF261673U&L_STATUS1=Completed &L_AMT1=1.00&L_FEEAMT1=-0.33&L_NETAMT1=0.67& L_TIMESTAMP2=2006-08-18T05:53:22Z&L_TIMEZONE2=GMT&L_TYPE2=Payment &L_NAME2=John+Doe&L_TRANSACTIONID2=6XB50622KC566325C&L_STATUS2=Completed &L_AMT2=1.00&L_FEEAMT2=-0.33&L_NETAMT2=0.67& L_TIMESTAMP3=2006-08-18T05:38:04Z&L_TIMEZONE3=GMT &L_TYPE3=Payment&L_NAME3=John+Doe&L_TRANSACTIONID3=80774637LP956560E& L_STATUS3=Completed&L_AMT3=1.00&L_FEEAMT3‑0.33&L_NETAMT3=0.67& L_TIMESTAMP4=2006-08-17T03:02:44Z&L_TIMEZONE4=GMT&L_TYPE4=Payment& L_NAME4=Pettibone+Smythe‑Jones&L_TRANSACTIONID4=8G40321568512733L& L_STATUS4=Completed&L_AMT4=104.00&L_FEEAMT4=‑3.32&L_NETAMT4=100.68

TransactionSearch returns a multi-valued array of all transactions that match the search criteria. Each transaction begins with its date: L_TIMESTAMPn, where n starts with 0 and increments by one for each transaction.

Viewing Details of a Single Transaction Using GetTransactionDetails

To view all details about a single transaction, use GetTransactionDetails.

Table 6.8

Viewing A Transaction’s Details

Request

[requiredSecurityParameters]&METHOD=GetTransactionDetails &TRANSACTIONID=3B288546P5019992D

Response

[successResponseFields]&RECEIVERBUSINESS=Jims+Hardware &RECEIVEREMAIL=jim@hardwareplace.com&RECEIVERID=WNSJNN89XVWFA &PAYERID=B3KS3VFYNG9SN&PAYERSTATUS=unverified&FIRSTNAME=James& LASTNAME=Biguy&COUNTRYCODE=US&SHIPTOSTATE=&ADDRESSID=PayPal&ADDRESSSTATUS=None &TRANSACTIONID=3B288546P5019992D&RECEIPTID=3596-6202-14612615 &TRANSACTIONTYPE=webaccept&PAYMENTTYPE=instant& ORDERTIME=2006-08-15T17:00:00Z&AMT=127.87&CURRENCYCODE=USD&FEEAMT=4.01 &TAXAMT=0.00&PENDINGREASON=None&REASONCODE=None&SALESTAX=0.00&L_QTY0=1