XML Examples

Billing Agreement Examples

Billing Agreement with Payment

This example shows how to create a billing agreement with payment by calling these services:

npayPalEcSetService

npayPalEcGetDetailsService

npayPalEcDoPaymentService

npayPalDoCaptureService

Example 32Request for payPalEcSetService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalEcSetService run="true">

      <paypalReturn>http://www.cybersource.com</paypalReturn>

      <paypalCancelReturn>http://www.cybersource.com/cancel</paypalCancelReturn>

      <paypalBillingAgreementDesc>Home Town Newspaper Online*4.99 per month
      </paypalBillingAgreementDesc>

      <paypalBillingType>MerchantInitiatedBilling</paypalBillingType>

      <paypalPaymentType>instant</paypalPaymentType>

      <paypalBillingAgreementCustom>One-year subscription
      </paypalBillingAgreementCustom>

   </payPalEcSetService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 33Reply from payPalEcSetService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>1928320121920167904854</c:requestID>

   <c:requestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalEcSetReply>

      <c:reasonCode>100</c:reasonCode>

      <c:correlationID>4lks03uw2lbwxu</c:correlationID>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:amount>4.99</c:amount>

   </c:payPalEcSetReply>

</c:replyMessage>
Example 34Request for payPalEcGetDetailsService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalEcGetDetailsService run="true">

      <paypalToken>EC-2UN29359TV924162S</paypalToken>

      <paypalEcSetRequestID>1928320121920167904854</paypalEcSetRequestID>

      <paypalEcSetRequestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk
      </paypalEcSetRequestToken>

   </payPalEcGetDetailsService>

</requestMessage>
Example 35Reply from payPalEcGetDetailsService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>29FJBLS93TBQPSLDGK3H</c:requestID>

   <c:requestToken>Bxwje3Ijb7OskjK6HGG0XF3vllnoyf</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalEcGetDetailsReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalBillingAgreementAcceptedStatus>1
         </c:paypalBillingAgreementAcceptedStatus>

      <c:correlationID>sldkf9325sdfsdlkjgj</c:correlationID>

      <c:avsCode>3</c:avsCode>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:addressStatus>Confirmed</c:addressStatus>

      <c:payerID>S6D5ETGSVYX94</c:payerID>

      <c:payerStatus>verified</c:payerStatus>

      <c:payerFirstname>Jane</c:payerFirstname>

      <c:payerLastname>Smith</c:payerLastname>

      <c:payerCountry>US</c:payerCountry>

      <c:payer>jsmith@example.com</c:payer>

      <c:shipToName>Jane Smith</c:shipToName>

      <c:shipToAddress1>1295 Charleston Rd.</c:shipToAddress1>

      <c:shipToCity>Mountain View</c:shipToCity>

      <c:shipToState>CA</c:shipToState>

      <c:shipToCountry>US</c:shipToCountry>

      <c:shipToZip>94043</c:shipToZip>

   </c:payPalEcGetDetailsReply>

</c:replyMessage>
Example 36Request for payPalEcDoPaymentService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalEcDoPaymentService run="true">

      <paypalToken>EC-2UN29359TV924162S</paypalToken>

      <paypalPayerId>S6D5ETGSVYX94</paypalPayerId>

      <paypalCustomerEmail>jsmith@examples.com</paypalCustomerEmail>

      <paypalEcSetRequestID>1928320121920167904854</paypalEcSetRequestID>

      <paypalEcSetRequestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk
      </paypalEcSetRequestToken>

   </payPalEcDoPaymentService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 37Reply from payPalEcDoPaymentService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>TN10C8B3MHS0AK3BKSGN8</c:requestID>

   <c:requestToken>Crdug4OkpF2Qfd8oXDD0ZE4vpp24</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalEcDoPaymentReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalBillingAgreementId>3ADOib340UWM8923lf20
         </c:paypalBillingAgreementId>

      <c:correlationID>sldkf9325sdfsdlkjgj</c:correlationID>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:paypalPaymentStatus>Pending</c:paypalPaymentStatus>

      <c:transactionId>2YG99268YE540943P</c:transactionId>

      <c:paymentType>None</c:paymentType>

      <c:paypalTaxAmount>0.00</c:paypalTaxAmount>

      <c:orderId>O-58X525738C493004E</c:orderId>

      <c:paypalTransactiontype>expresscheckout</c:paypalTransactiontype>

      <c:paypalPendingReason>order</c:paypalPendingReason>

      <c:errorCode>93045SLWVO</c:errorCode>

   </c:payPalEcDoPaymentReply>

</c:replyMessage>
Example 38Request for payPalDoCaptureService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalDoCaptureService run="true">

      <paypalAuthorizationId>2YG99268YE540943P</paypalAuthorizationId>

      <completeType>Complete</completeType>

      <paypalEcDoPaymentRequestID>TN10C8B3MHS0AK3BKSGN8
      </paypalEcDoPaymentRequestID>

      <paypalEcDoPaymentRequestToken>Crdug4OkpF2Qfd8oXDD0ZE4vpp24
      </paypalEcDoPaymentRequestToken>

   </payPalDoCaptureService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 39Reply from payPalDoCaptureService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>FY25W8N9OWC2LE7WOCBU5</c:requestID>

   <c:requestToken>Dtely5OsoW3Pnw0mWVV9x26mll35</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalDoCaptureReply>

      <c:reasonCode>100</c:reasonCode>

      <c:transactionId>2SA82969X3543562X</c:transactionId>

      <c:parentTransactionId>2YG99268YE540943P</c:parentTransactionId>

      <c:authorizationId>2YG99268YE540943P</c:authorizationId>

      <c:paypalPaymentStatus>Completed</c:paypalPaymentStatus>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:correlationId>gwlbof9325biwflpaj</c:correlationId>

      <c:paypalPaymentType>instant</c:paypalPaymentType>

      <c:paypalPaymentGrossAmount>4.99</c:paypalPaymentGrossAmount>

      <c:paypalTaxAmount>0.00</c:paypalTaxAmount>

      <c:paypalFeeAmount>0.36</c:paypalFeeAmount>

      <c:paypalTransactiontype>expresscheckout</c:paypalTransactiontype>

   </c:payPalDoCaptureReply>

</c:replyMessage>

Billing Agreement without Payment

This example shows how to create a billing agreement without payment by calling these services:

npayPalEcSetService

npayPalEcGetDetailsService

npayPalCreateAgreementService

Example 40Request for payPalEcSetService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalEcSetService run="true">

      <paypalReturn>http://www.cybersource.com</paypalReturn>

      <paypalCancelReturn>http://www.cybersource.com/cancel</paypalCancelReturn>

      <paypalBillingType>MerchantInitiatedBilling</paypalBillingType>

      <paypalBillingAgreementDesc>Home Town Newspaper Online*4.99 per month
      </paypalBillingAgreementDesc>

      <paypalPaymentType>instant</paypalPaymentType>

      <paypalBillingAgreementCustom>One-year subscription
      </paypalBillingAgreementCustom>

   </payPalEcSetService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>0</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 41Reply from payPalEcSetService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>1928320121920167904854</c:requestID>

   <c:requestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalEcSetReply>

      <c:reasonCode>100</c:reasonCode>

      <c:correlationID>4lks03uw2lbwxu</c:correlationID>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:amount>0</c:amount>

   </c:payPalEcSetReply>

</c:replyMessage>
Example 42Request for payPalEcGetDetailsService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalEcGetDetailsService run="true">

      <paypalToken>EC-2UN29359TV924162S</paypalToken>

      <paypalEcSetRequestID>1928320121920167904854</paypalEcSetRequestID>

      <paypalEcSetRequestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk
         </paypalEcSetRequestToken>

   </payPalEcGetDetailsService>

</requestMessage>
Example 43Reply from payPalEcGetDetailsService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>29FJBLS93TBQPSLDGK3H</c:requestID>

   <c:requestToken>Bxwje3Ijb7OskjK6HGG0XF3vllnoyf</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalEcGetDetailsReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalBillingAgreementAcceptedStatus>1
         </c:paypalBillingAgreementAcceptedStatus>

      <c:correlationID>sldkf9325sdfsdlkjgj</c:correlationID>

      <c:avsCode>3</c:avsCode>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:addressStatus>Confirmed</c:addressStatus>

      <c:payerID>S6D5ETGSVYX94</c:payerID>

      <c:payerStatus>verified</c:payerStatus>

      <c:payerFirstname>Jane</c:payerFirstname>

      <c:payerLastname>Smith</c:payerLastname>

      <c:payerCountry>US</c:payerCountry>

      <c:payer>jsmith@example.com</c:payer>

      <c:shipToName>Jane Smith</c:shipToName>

      <c:shipToAddress1>1295 Charleston Rd.</c:shipToAddress1>

      <c:shipToCity>Mountain View</c:shipToCity>

      <c:shipToState>CA</c:shipToState>

      <c:shipToCountry>US</c:shipToCountry>

      <c:shipToZip>94043</c:shipToZip>

   </c:payPalEcGetDetailsReply>

</c:replyMessage>
Example 44Request for payPalCreateAgreementService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalCreateAgreementService run="true">

      <paypalToken>EC-2UN29359TV924162S</paypalToken>

      <paypalEcSetRequestID>1928320121920167904854</paypalEcSetRequestID>

      <paypalEcSetRequestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk
      </paypalEcSetRequestToken>

   </payPalCreateAgreementService>

</requestMessage>
Example 45Reply from payPalCreateAgreementService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <crequestID>29FJBLS93TBQPSLDGK3H</c:requestID>

   <c:requestToken>Bxwje3Ijb7OskjK6HGG0XF3vllnoyf</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalCreateAgreementReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalBillingAgreementId>3ADOib340UWM8923lf20
         </c:paypalBillingAgreementId>

   </c:payPalCreateAgreementReply>

</c:replyMessage>

Reference Transaction

This example shows how to use a reference transaction to authorize and capture a payment by calling these services:

npayPalDoRefTransactionService

npayPalAuthorizationService

npayPalDoCaptureService

Example 46Request for payPalDoRefTransactionService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalDoRefTransactionService run="true">

      <paypalBillingAgreementId>3ADOib340UWM8923lf20</paypalBillingAgreementId>

      <paypalPaymentType>instant</paypalPaymentType>

   </payPalDoRefTransactionService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 47Reply from payPalDoRefTransactionService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>023mbdgil2spfkgjqdbvn</c:requestID>

   <c:requestToken>slbiw9345BJldbodflBNQCPE1409D9k</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalDoRefTransactionReply>

      <c:reasonCode>100</c:reasonCode>

      <c:correlationID>4lks03uw2lbwxu</c:correlationID>

      <c:paypalToken>EC-2UN29359TV924162S</c:paypalToken>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:amount>4.99</c:amount>

      <c:currency>USD</c:currency>

      <c:paypalAmount>4.99</c:paypalAmount>

      <c:paypalBillingAgreementId>3ADOib340UWM8923lf20</c:paypalBillingAgreementId>

      <c:paypalOrderTime>2009-08-15T17:23:09Z</c:paypalOrderTime>

      <c:paypalPaymentStatus>Completed</c:paypalPaymentStatus>

      <c:paypalPaymentType>instant</c:paypalPaymentType>

      <c:paypalPendingReason>none</c:paypalPendingReason>

      <c:paypalReasonCode>none</c:paypalReasonCode>

      <c:paypalTaxAmount>0.00</c:paypalTaxAmount>

      <c:paypalTransactiontype>express-checkout</c:paypalTransactiontype>

      <c:transactionId>htnsubw30bwlbnq2</c:transactionId>

   </c:payPalDoRefTransactionReply>

</c:replyMessage>
Example 48Request for payPalAuthorizationService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalAuthorizationService run="true">

      <paypalDoRefTransactionRequestID>023mbdgil2spfkgjqdbvn
      </paypalDoRefTransactionRequestID>

      <paypalDoRefTransactionRequestToken>slbiw9345BJldbodflBNQCPE1409D9k
      </paypalDoRefTransactionRequestToken>

      <paypalCustomerEmail>jsmith@example.com</paypalCustomerEmail>

   </payPalAuthorizationService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 49Reply from payPalAuthorizationService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>49gks2og0g12wrg879aergsk</c:requestID>

   <c:requestToken>SLGQ30B235b0XCV0lskb2369awopSgm</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalAuthorizationReply>

      <c:reasonCode>100</c:reasonCode>

      <c:correlationID>4lks03uw2lbwxu</c:correlationID>

      <c:errorCode>93045SLWVO</c:errorCode>

      <c:amount>4.99</c:amount>

      <c:currency>USD</c:currency>

      <c:paypalAmount>4.99</c:paypalAmount>

      <c:transactionId>3GT12375C398240X</c:transactionId>

   </c:payPalAuthorizationReply>

</c:replyMessage>
Example 50Request for payPalDoCaptureService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalDoCaptureService run="true">

      <paypalAuthorizationId>9XT12375C2469923X</paypalAuthorizationId>

      <completeType>Complete</completeType>

      <paypalAuthorizationRequestID>49gks2og0g12wrg879aergsk
      </paypalAuthorizationRequestID>

      <paypalAuthorizationRequestToken>SLGQ30B235b0XCV0lskb2369awopSgm
      </paypalAuthorizationRequestToken>

   </payPalDoCaptureService>

   <purchaseTotals>

      <currency>USD</currency>

      <grandTotalAmount>4.99</grandTotalAmount>

   </purchaseTotals>

</requestMessage>
Example 51Reply from payPalDoCaptureService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>203948106391278015965</c:requestID>

   <c:requestToken>FFv9VEdZAOGh084W7RJzIIzHUTUL</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalDoCaptureReply>

      <c:reasonCode>100</c:reasonCode>

      <c:correlationID>r2lvp9325sdfsdlkjgj</c:correlationID>

      <c:errorCode>sboe93045</c:errorCode>

      <c:amount>4.99</c:amount>

      <c:currency>USD</c:currency>

      <c:paypalPaymentType>instant</c:paypalPaymentType>

      <c:paypalPaymentGrossAmount>4.99</c:paypalPaymentGrossAmount>

      <c:paypalTaxAmount>0.00</c:paypalTaxAmount>

      <c:paypalFeeAmount>0.36</c:paypalFeeAmount>

      <c:paypalTransactiontype>cart</c:paypalTransactiontype>

      <c:transactionId>4M8612956X2810426</c:transactionId>

      <c:parentTransactionId>9XT12375C2469923X</c:parentTransactionId>

      <c:authorizationId>0YU23486D3570034Y</c:authorizationId>

      <c:paypalPaymentStatus>Completed</c:paypalPaymentStatus>

   </c:payPalDoCaptureReply>

<c:/replyMessage>

Cancellation

This example shows how to cancel a billing agreement by calling the payPalUpdateAgreementService service.

Example 52Request for payPalUpdateAgreementService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.47">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalUpdateAgreementService run="true">

      <paypalBillingAgreementID>3ADOib340UWM8923lf20</paypalBillingAgreementID>

      <paypalBillingAgreementStatus>Canceled</paypalBillingAgreementStatus>

   </payPalUpdateAgreementService>

</requestMessage>
Example 53Reply from payPalUpdateAgreementService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.47">

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestID>1928320121920167904854</c:requestID>

   <c:requestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk</c:requestToken>

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:payPalUpdateAgreementReply>

      <c:reasonCode>100</c:reasonCode>

      <c:addressStatus>Confirmed</c:addressStatus>

      <c:payer>jsmith@example.com</c:payer>

      <c:payerBusiness>Home Town Newspaper</c:payerBusiness>

      <c:payerCountry>US</c:payerCountry>

      <c:payerFirstname>Jane</c:payerFirstname>

      <c:payerLastname>Smith</c:payerLastname>

      <c:payerId>S6D5ETGSVYX94</c:payerId>

      <c:payerStatus>verified</c:payerStatus>

      <c:paypalBillingAgreementCustom>One-year subscription
         </c:paypalBillingAgreementCustom>

      <c:paypalBillingAgreementDesc>Home Town Newspaper Online*4.99 per month
         </c:paypalBillingAgreementDesc>

      <c:paypalBillingAgreementID>3ADOib340UWM8923lf20</c:paypalBillingAgreementID>

      <c:paypalBillingAgreementStatus>Canceled</c:paypalBillingAgreementStatus>

      <c:correlationID>4lks03uw2lbwxu</c:correlationID>

      <c:errorCode>93045SLWVO</c:errorCode>

   </c:payPalUpdateAgreementReply>

</c:replyMessage>

Item-Level Examples

 

To enable item-level fields, contact Cybersource Customer Support to have your account configured for this feature.
Example 54Request for payPalEcSetService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.72">

   <merchantID>HomeTownBooks</merchantID>

   <merchantReferenceCode>HTBorder9647</merchantReferenceCode>

   <item id="0">

      <unitPrice>22.00</unitPrice>

      <quantity>1</quantity>

      <productCode>books</productCode>

      <productName>Merriam-Webster Dictionary</productName>

      <productSKU>23456</productSKU>

      <taxAmount>1.10</taxAmount>

   </item>

   <item id="1">

      <unitPrice>24.00</unitPrice>

      <quantity>1</quantity>

      <productCode>books</productCode>

      <productName>Handbook of English Grammar</productName>

      <productSKU>23458</productSKU>

      <taxAmount>1.20</taxAmount>

   </item>

   <item id="2">

      <unitPrice>16.00</unitPrice>

      <quantity>1</quantity>

      <productCode>books</productCode>

      <productName>Roget's Thesaurus</productName>

      <productSKU>23450</productSKU>

      <taxAmount>0.80</taxAmount>

   </item>

   <item id="3">

      <unitPrice>5.00</unitPrice>

      <quantity>1</quantity>

      <productCode>coupon</productCode>

      <productName>First-Time Buyer Coupon</productName>

      <productSKU>97531</productSKU>

   </item>

   <item id="4">

      <unitPrice>7.95</unitPrice>

      <productCode>shipping_and_handling</productCode>

   </item>

   <purchaseTotals><currency>USD</currency></purchaseTotals>

   <payPalEcSetService run="true">

      <paypalReturn>http://www.cybersource.com</paypalReturn>

      <paypalCancelReturn>http://www.cybersource.com/cancel</paypalCancelReturn>

   </payPalEcSetService>

</requestMessage>
Example 55Reply from payPalEcSetService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.72">

   <c:merchantReferenceCode>HTBorder9647</c:merchantReferenceCode>

   <c:requestID>KPTRWUMC123893lsng</c:requestID>

   <c:requestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk</c:requestToken>

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:payPalEcSetReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalToken>349GJlk2jk34993</c:paypalToken>

      <c:correlationID>5lks03uw3lawxz</c:correlationID>

      <c:errorCode>911245SVtsO</c:errorCode>

   </c:payPalEcSetReply>

</c:replyMessage>
Example 56Request for payPalEcGetDetailsService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.78">

   <merchantID>HomeTownBooks</merchantID>

   <merchantReferenceCode>HTBorder9647</merchantReferenceCode>

   <payPalEcGetDetailsService run="true">

      <paypalToken>349GJlk2jk34993</paypalToken>

      <payPalEcSetRequestID>KPTRWUMC123893lsng</payPalEcSetRequestID>

      <paypalEcSetRequestToken>Aeuvj6IjRRjVhjIZWEEvhhf8jZL4YX/I20gRk
         </paypalEcSetRequestToken>

   </payPalEcGetDetailsService>

</requestMessage>
Example 57Reply from payPalEcGetDetailsService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.78">

   <c:merchantReferenceCode>HTBorder9647</c:merchantReferenceCode>

   <c:requestID>RZ34980sctj2</c:requestID>

   <c:requestToken>Bxwje3Ijb7OskjK6HGG0XF3vllnoyf</c:requestToken>

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <item id="0">

      <unitPrice>22.00</unitPrice>

      <quantity>1</quantity>

      <productCode>default</productCode>

      <productName>Merriam-Webster Dictionary</productName>

      <productSKU>23456</productSKU>

   </item>

   <item id="1">

      <unitPrice>24.00</unitPrice>

      <quantity>1</quantity>

      <productCode>default</productCode>

      <productName>Handbook of English Grammar</productName>

      <productSKU>23458</productSKU>

   </item>

   <item id="2">

      <unitPrice>16.00</unitPrice>

      <quantity>1</quantity>

      <productCode>default</productCode>

      <productName>Roget's Thesaurus</productName>

      <productSKU>23450</productSKU>

   </item>

   <item id="3">

      <unitPrice>5.00</unitPrice>

      <quantity>1</quantity>

      <productCode>coupon</productCode>

      <productName>First-Time Buyer Coupon</productName>

      <productSKU>97531</productSKU>

   </item>

   <item id="4">

      <unitPrice>7.95</unitPrice>

      <productCode>shipping_and_handling</productCode>

   </item>

   <c:payPalEcGetDetailsReply>

      <c:reasonCode>100</c:reasonCode>

      <c:paypalToken>349GJlk2jk34993</c:paypalToken>

      <c:payer>jsmith@example.com</c:payer>

      <c:payerID>S6D5ETGSVYX94</c:payerID>

      <c:payerStatus>verified</c:payerStatus>

      <c:payerFirstname>Jane</c:payerFirstname>

      <c:payerLastname>Smith</c:payerLastname>

      <c:payerCountry>US</c:payerCountry>

      <c:shipToName>Jane Smith</c:shipToName>

      <c:shipToAddress1>1295 Charleston Rd.</c:shipToAddress1>

      <c:shipToCity>Mountain View</c:shipToCity>

      <c:shipToState>CA</c:shipToState>

      <c:shipToCountry>US</c:shipToCountry>

      <c:shipToZip>94043</c:shipToZip>

      <c:addressStatus>Confirmed</c:addressStatus>

      <c:avsCode>3</c:avsCode>

      <c:correlationID>6ksz03np4lbwxy</c:correlationID>

      <c:errorCode>822236PXnw3</c:errorCode>

      <c:paypalTaxAmount>3.10</c:paypalTaxAmount>

   </c:payPalEcSetReply>

</c:replyMessage>

Transaction Search Example

Example 58Request for payPalTransactionSearchService

<requestMessage xmlns="urn:schemas-cybersource-com:transaction-data-1.78">

   <merchantID>HomeTownNewspaper</merchantID>

   <merchantReferenceCode>HTNsubscription9647</merchantReferenceCode>

   <payPalTransactionSearchService run="true">

      <startDate>2012-09-25T18:47:13Z</startDate>

      <endDate>2012-09-25T18:49:13Z</endDate>

      <paypalCustomerEmail>jsmith@example.com</paypalCustomerEmail>

      <transactionID>93N51798SX666845X</transactionID>

      <invoiceNumber>0001529</invoiceNumber>

      <grandTotalAmount>5.00</grandTotalAmount>

      <currency>USD</currency>

      <paymentStatus>Success</paymentStatus>

      <payerFirstname>Jane</payerFirstname>

      <payerLastname>Smith</payerLastname>

   </payPalTransactionSearchService>

</requestMessage>
Example 59Reply from payPalTransactionSearchService

<c:replyMessage xmlns:c="urn:schemas-cybersource-com:transaction-data-1.78">

   <c:merchantReferenceCode>HTNsubscription9647</c:merchantReferenceCode>

   <c:requestID>3485988938400181552773</c:requestID>

   <c:decision>ACCEPT</c:decision>

   <c:reasonCode>100</c:reasonCode>

   <c:requestToken>AhjrLwSRefOhK9P3yQ0KIJp7HBMVhNPMrTnpa4sA/H2H</c:requestToken>

   <c:payPalTransactionSearchReply>

      <c:reasonCode>100</c:reasonCode>

      <c:transaction id="0">

         <c:transactionTime>2012-09-25T18:48:11Z</c:transactionTime>

         <c:transactionTimeZone>GMT</c:transactionTimeZone>

         <c:transactionType>Payment</c:transactionType>

         <c:paypalPayerOrPayeeEmail>jsmith@example.com</c:paypalPayerOrPayeeEmail>

         <c:customerDisplayName>Jane Smith</c:customerDisplayName>

         <c:transactionID>93N51798SX666845X</c:transactionID>

         <c:paypalPaymentStatus>Completed</c:paypalPaymentStatus>

         <c:grandTotalAmount>5.00</c:grandTotalAmount>

         <c:currency>USD</c:currency>

         <c:paypalFeeAmount>-0.45</c:paypalFeeAmount>

         <c:paypalNetAmount>4.55</c:paypalNetAmount>

      </c:transaction>

      <c:transaction id="1">

         <c:transactionTime>2012-09-25T18:48:05Z</c:transactionTime>

         <c:transactionTimeZone>GMT</c:transactionTimeZone>

         <c:transactionType>Authorization</c:transactionType>

         <c:paypalPayerOrPayeeEmail>jsmith@example.com</c:paypalPayerOrPayeeEmail>

         <c:customerDisplayName>Jane Smith</c:customerDisplayName>

         <c:transactionID>8KV00008PR858651B</c:transactionID>

         <c:paypalPaymentStatus>Completed</c:paypalPaymentStatus>

         <c:grandTotalAmount>5.00</c:grandTotalAmount>

         <c:currency>USD</c:currency>

         <c:paypalFeeAmount>0.00</c:paypalFeeAmount>

         <c:paypalNetAmount>5.00</c:paypalNetAmount>

      </c:transaction>

   </c:payPalTransactionSearchReply>

</c:replyMessage>