Radial Integration | 2016

PayPal GetExpress

API Description

GetExpress request uses the Token received in the SetExpress response message to retrieve information about the customer (referred to as Payer). The most important and useful element of the information returned in the GetExpress response is PayerId. PayerId is used to uniquely identify the customer and is used in the next call in the PayPal Checkout flow, the DoExpress request.

For Express Checkout Easy Payments, it will return additional financing information in the GetExpress reply.

URI Summary

Request Elements

Request Example

The request is a PayPalGetExpressCheckoutRequest message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalGetExpressCheckoutRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <Token>EC-5YE59312K56892714</Token>
  <CurrencyCode>"USD"</CurrencyCode>
  <SchemaVersion>1.1</SchemaVersion>
</PayPalGetExpressCheckoutRequest>

Response Elements

Successful Response Example

The response is a PayPalGetExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalGetExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <ResponseCode>Success</ResponseCode>
  <PayerEmail>payer@gmail.com</PayerEmail>
  <PayerId>CNQNHXX9RCE9S</PayerId>
  <PayerStatus>Verified</PayerStatus>
  <PayerName>
    <Honorific>Mr.</Honorific>
    <LastName>Smith</LastName>
    <MiddleName>Michael</MiddleName>
    <FirstName>John</FirstName>
  </PayerName>
  <PayerCountry>US</PayerCountry>
  <BillingAddress>
    <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>
  </BillingAddress>
  <PayerPhone>2152221111</PayerPhone>
  <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>
</PayPalGetExpressCheckoutReply>

Successful Response Example with Different Billing and Shipping Address

The response is a PayPalGetExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalGetExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>559749</OrderId>
  <ResponseCode>Success</ResponseCode>
  <PayerEmail>chopuk_1326139738_per@gsicommerce.com</PayerEmail>
  <PayerId>CNQNHXX9RCE9S</PayerId>
  <PayerStatus>verified</PayerStatus>
  <PayerName>
    <LastName>User</LastName>
    <FirstName>Test</FirstName>
  </PayerName>
  <PayerCountry>GB</PayerCountry>
  <BillingAddress>
    <Line1>49 Featherstone Street</Line1>
    <Line2/>
    <City>LONDON</City>
    <MainDivision>London</MainDivision>
    <CountryCode>GB</CountryCode>
    <PostalCode>EC1Y 8SY</PostalCode>
  </BillingAddress>
  <PayerPhone>+44 3565606206</PayerPhone>
  <ShippingAddress>
    <Line1>49 Queen Blvd</Line1>
    <Line2/>
    <City>Manchester</City>
    <MainDivision>Manchester</MainDivision>
    <CountryCode>GB</CountryCode>
    <PostalCode>MU1Y 8SY</PostalCode>
  </ShippingAddress>
</PayPalGetExpressCheckoutReply>

Successful Response Example with Express Checkout Easy Payments

The response is a PayPalGetExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalGetExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <ResponseCode>Success</ResponseCode>
  <PayerEmail>payer@gmail.com</PayerEmail>
  <PayerId>CNQNHXX9RCE9S</PayerId>
  <PayerStatus>Verified</PayerStatus>
  <PayerName>
    <Honorific>Mr.</Honorific>
    <LastName>Smith</LastName>
    <MiddleName>Michael</MiddleName>
    <FirstName>John</FirstName>
  </PayerName>
  <PayerCountry>US</PayerCountry>
  <BillingAddress>
    <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>
  </BillingAddress>
  <PayerPhone>2152221111</PayerPhone>
  <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>
  <PaymentInfo>
    <FinancingApproved>true</FinancingApproved>
    <FinancingFeeAmount currencyCode="USD">26.79</FinancingFeeAmount>
    <FinancingTerm>24</FinancingTerm>
    <FinancingMonthlyPayment currencyCode="USD">426.89</FinancingMonthlyPayment>
    <FinancingTotalCost currencyCode="USD">485.35.79</FinancingTotalCost>
  </PaymentInfo>
  <CartChangeTolerance>NONE</CartChangeTolerance>
</PayPalGetExpressCheckoutReply>

Failure Response Example

The response is a PayPalGetExpressCheckoutReply message.

<?xml version="1.0" encoding="UTF-8"?>
<PayPalGetExpressCheckoutReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
  <OrderId>12345</OrderId>
  <ResponseCode>Failure</ResponseCode>
  <PayerEmail></PayerEmail>
  <PayerId></PayerId>
  <PayerStatus>Unverified</PayerStatus>
  <PayerName>
    <Honorific></Honorific>
    <LastName></LastName>
    <MiddleName></MiddleName>
    <FirstName></FirstName>
  </PayerName>
  <ErrorMessage>Invalid Token.</ErrorMessage>
  <ShortErrorMessage>Invalid Token.</ShortErrorMessage>
  <ErrorCode>1234</ErrorCode>
</PayPalGetExpressCheckoutReply>

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 a successful GetExpress call, the next step is a DoExpress call.

Copyright © 2017 Radial. All rights reserved.