Radial Integration | 2016

PayPal DoExpress

Overview

The PayPal DoExpress request uses the Token and PayerId elements retrieved from the SetExpress and GetExpress responses. DoExpress is used to place a PayPal order and return a TransactionId which is the identifier for the PayPal order. The TransactionId is also used as the as the Billing Agreement Id if this order is part of a recurring order (Recurring flag is set to true in the SetExpress request).

URI Summary

Request Elements

When preparing the request, consider the following data notes:

• Negative Line Items Amounts are allowed and can be used to apply discounts, and LineItemsTotal can also be negative. However, the sum of LineItemsTotal + ShippingTotal + TaxTotal, which equals the request Amount, cannot be negative.
• PickUpStoreId should be sent only if the intent is to ship to the store.
• TransactionId serves as the Billing Agreement Id if the Recurring flag is set to true in the SetExpress request.

Request Example

The request is a PayPalDoExpressCheckoutRequest message.

<?xml version="1.0" encoding="UTF-8"?>
  <PayPalDoExpressCheckoutRequest 
       xmlns="http://api.gsicommerce.com/schema/checkout/1.0" requestId="1234567">
    <OrderId>12345</OrderId>
    <Token>EC-5YE59312K56892714</Token>
    <PayerId>CNQNHXX9RCE9S</PayerId>
    <Amount currencyCode="USD">60.00</Amount>
    <ShipToName>John Smith</ShipToName>
    <PickUpStoreId>AStoreId</PickUpStoreId>
    <ShippingAddress>
      <Line1>630 Allendale Road</Line1>
      <Line2>Building A</Line2>
      <Line3>2nd Floor</Line3>
      <Line4>Appartment 17</Line4>
      <City>Philadelphia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>USA</CountryCode>
      <PostalCode>19001</PostalCode>
    </ShippingAddress>
    <LineItems>
      <LineItemsTotal currencyCode="USD">20.00</LineItemsTotal>
      <ShippingTotal currencyCode="USD">20.00</ShippingTotal>
      <TaxTotal currencyCode="USD">20.00</TaxTotal>
      <LineItem>
        <Name>Shirt</Name>
        <SequenceNumber>1</SequenceNumber>
        <Quantity>2</Quantity>
        <UnitAmount currencyCode="USD">10.00</UnitAmount>
      </LineItem>
    </LineItems>
    <SchemaVersion>1.1</SchemaVersion>
  </PayPalDoExpressCheckoutRequest>    

Request Example with Multiple Line Items

The request is a PayPalDoExpressCheckoutRequest message.

<?xml version="1.0" encoding="UTF-8"?>
  <PayPalDoExpressCheckoutRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <OrderId>1234567</OrderId>
    <Token>EC-5YE59312K56892714</Token>
    <PayerId>PayerId0</PayerId> 
    <Amount currencyCode="USD">115.00</Amount>
    <ShipToName>John Smith</ShipToName>
    <ShippingAddress>
      <Line1>123 Main St.</Line1>
      <City>Philadelphia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19019</PostalCode>
    </ShippingAddress>
    <LineItems>
      <LineItemsTotal currencyCode="USD">100.00</LineItemsTotal>
      <ShippingTotal currencyCode="USD">10.00</ShippingTotal>
      <TaxTotal currencyCode="USD">5.00</TaxTotal>
      <LineItem>
        <Name>Product A</Name>
        <SequenceNumber>1</SequenceNumber>
        <Quantity>1</Quantity>
        <UnitAmount currencyCode="USD">50.00</UnitAmount>
      </LineItem>
      <LineItem>
        <Name>Product B</Name>
        <SequenceNumber>2</SequenceNumber>
        <Quantity>1</Quantity>
        <UnitAmount currencyCode="USD">50.00</UnitAmount>
      </LineItem>
    </LineItems>
  </PayPalDoExpressCheckoutRequest>

Request Example with Negative Line Item Amount

The request is a PayPalDoExpressCheckoutRequest message.

<?xml version="1.0" encoding="UTF-8"?>
  <PayPalDoExpressCheckoutRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <OrderId>1234567</OrderId>
    <Token>EC-5YE59312K56892714</Token>
    <PayerId>PayerId0</PayerId> 
    <Amount currencyCode="USD">55.00</Amount>
    <ShipToName>John Smith</ShipToName>
    <ShippingAddress>
      <Line1>123 Main St.</Line1>
      <City>Philadelphia</City>
      <MainDivision>PA</MainDivision>
      <CountryCode>US</CountryCode>
      <PostalCode>19019</PostalCode>
    </ShippingAddress>
    <LineItems>
      <LineItemsTotal currencyCode="USD">40.00</LineItemsTotal>
      <ShippingTotal currencyCode="USD">10.00</ShippingTotal>
      <TaxTotal currencyCode="USD">5.00</TaxTotal>
      <LineItem>
        <Name>Product A</Name>
        <SequenceNumber>1</SequenceNumber>
        <Quantity>1</Quantity>
        <UnitAmount currencyCode="USD">50.00</UnitAmount>
      </LineItem>
      <LineItem>
        <Name>Discount</Name>
        <SequenceNumber>2</SequenceNumber>
        <Quantity>1</Quantity>
        <UnitAmount currencyCode="USD">-10.00</UnitAmount>
      </LineItem>
    </LineItems>
  </PayPalDoExpressCheckoutRequest>

Response Elements

Successful Response Example

The response is a PayPalDoExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalDoExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <ResponseCode>Success</ResponseCode>
  <TransactionID>O-3A919253XG323924A</TransactionID>
  <PaymentInfo>
    <PaymentStatus>Pending</PaymentStatus>
    <PendingReason>Order</PendingReason>
    <ReasonCode>12345</ReasonCode>
  </PaymentInfo>
</PayPalDoExpressCheckoutReply>

Failure Response Example

The response is a PayPalDoExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalDoExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <ResponseCode>Failure</ResponseCode>
  <PaymentInfo>
    <PaymentStatus>None</PaymentStatus>
    <PendingReason>None</PendingReason>
    <ReasonCode>None</ReasonCode>
  </PaymentInfo>
  <ErrorMessage>Invalid Token.</ErrorMessage>
  <ShortErrorMessage>Invalid Token.</ShortErrorMessage>
  <ErrorCode>1234</ErrorCode>
</PayPalDoExpressCheckoutReply>

Timeout Response Example

The response is a XmlFaultReply message.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<XmlFaultReply xmlns="http://schema.gsicommerce.com/payments/services/1.0/"
    xmlns:payment="http://schema.gsicommerce.com/payments/types/1.0/">
  <payment:CreateTimestamp>2012-01-26T17:09:07.046Z</payment:CreateTimestamp>
  <payment:Code>SocketTimeoutException</payment:Code>
  <payment:Description>Read timed out</payment:Description>
</XmlFaultReply>

Next Step

After the successful Paypal DoExpress call, the next step is a DoAuthorize call.

Copyright © 2017 Radial. All rights reserved.