Paze℠ Authorize Payment
The Credit Card Authorization Request with Paze Wallet information is the only API required for merchants to integrate with Radial. It is used for Paze authorization process. As part of Authorization response, webstore will receive response code based on which they can either display confirmation page or declined page
URI Summary
|
Action |
URI Template |
URI Example |
Non-URI Request |
Response |
|---|---|---|---|---|
|
POST |
/v[M.m]/stores/[StoreID]/ |
/v1.0/stores/store123/ |
XML |
200 + XML response |
Schema
The schema for Credit Card Digital Wallet Authorization is Payment-Service-CreditCardAuth-1.0.xsd.
Request Example
The request is a CreditCardAuthRequest using the WalletPaymentInformation block.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CreditCardAuthRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" requestId="1234567">
<WalletPaymentInformation>
<PazeData>rs97b9L243rd/eV6e7FYTqIfqOcA28jq0hgea6IcPrFZrQZg6/jtLLr0QY/NGY3PIiYlSv7cjslD1MznBmEHjqWoueZUufuE0SvbHSyJodJbx/ABxEc6pbUKFD0OHGbWwZAusIP7eE19AKR3gUwfHYGlAUJcpUXs2z6eFbFLiBve3yGn5oauzxLzwoUkt5O2OUbOyLR17WIIz7bWogynJrfLIVGtk72y7PLUH+ewOv6T91C+tILeK+2xgwvJt/sQTonRwh4DQDtecqCFpMGxnOEgvjynZxubcLIMPfsRjkRdWAbyd2CNHVPhtoE++LNXzqxbQFiT81fDUSHv1Q6AUtxeuACQulckazi51SrPd+uxxAjuCHBQZbRWuZZIN2pVypdu1iGePLjAO7dEqlO+ppT0hUQbrMJjFRPmYlAhSgF5Pc4NDf+IyqdU3A+P6kt2fwuHwHsY4o7JCAb7qwtrGgmGpSkBU50UHtzI3qrQ8GraJ0N3FUx/Lst4VWGAwUAwNOPpnHnAeYbgho6nVECQ2yGbV+mwYR6oA0LXuK2ZeBPsiUOL</PazeData>
</WalletPaymentInformation>
<OrderId>1</OrderId>
<Amount currencyCode="USD">14.99</Amount>
<BillingFirstName>John</BillingFirstName>
<BillingLastName>Smith</BillingLastName>
<BillingPhoneNo>6101234567</BillingPhoneNo>
<BillingAddress>
<Line1>123 Main St</Line1>
<Line2>Building 123</Line2>
<Line3>4th Floor</Line3>
<Line4>Apt 12</Line4>
<City>Philadelphia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19019</PostalCode>
</BillingAddress>
<CustomerEmail>customer@sample.com</CustomerEmail>
<CustomerIPAddress>208.247.73.130</CustomerIPAddress>
<ShipToFirstName>John</ShipToFirstName>
<ShipToLastName>Smith</ShipToLastName>
<ShipToPhoneNo>6101234567</ShipToPhoneNo>
<ShippingAddress>
<Line1>123 Main St</Line1>
<Line2>Building 123</Line2>
<Line3>4th Floor</Line3>
<Line4>Apt 12</Line4>
<City>Philadelphia</City>
<MainDivision>PA</MainDivision>
<CountryCode>US</CountryCode>
<PostalCode>19019</PostalCode>
</ShippingAddress>
<Features>
<IncludePaymentAccountInformation>true</IncludePaymentAccountInformation>
</Features>
</CreditCardAuthRequest>Request Elements
Note: The following description contains mapping between the Paze SDK JS checkout and complete fields with CreditCardAuthRequest. For sample Checkout, Complete Requests/Responses refer to: Paze SDK Integration.
|
Element |
Optional/Required |
Description |
Type |
Restriction |
|---|---|---|---|---|
| CreditCardAuthRequest/WalletPaymentInformation | Yes | Digital Wallet Payment Information. | ComplexType | |
| CreditCardAuthRequest/WalletPaymentInformation/ PazeData |
Yes | Encrypted Payment Data, corresponding to encryptedMessage. Map the Paze SDK JS completeResponse to this field | Base64 encoded string | |
| CreditCardAuthRequest/OrderId | Yes | Unique identifier of the order The client must ensure uniqueness of OrderIds across all orders that the client initiates with this service. | String | Min 1 character Max 20 characters |
| CreditCardAuthRequest/Amount | Yes | Amount value to authorize for the order. Get this value from Paze SDK JS completeRequest.transactionValue.amount | String | Positive decimal, up to two decimal places(for example, 4.75) |
| CreditCardAuthRequest/Amount/ @currencyCode |
Yes | Type of currency used for the amount. Get this value from Paze SDK JS completeRequest.transactionValue.currency | String | 3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/wiki/ISO_4217. |
| CreditCardAuthRequest/BillingFirstName | Yes | First name of the person on the billing address of the credit card. Get this value from Paze SDK JS checkoutResponse.consume.firstName | String | |
| CreditCardAuthRequest/BillingLastName | Yes | Last name of the person on the billing address of the credit card. Get this value from Paze SDK JS checkoutResponse.consume.lastName | String | |
| CreditCardAuthRequest/BillingPhoneNo | Yes | Phone number of the person on the billing address of the credit card. Get this value from Paze SDK JS checkoutResponse.consume.mobileNumber.phoneNumber | String | |
| CreditCardAuthRequest/BillingAddress | Yes (for AVS verification) | Billing address of the credit card | ComplexType | |
| CreditCardAuthRequest/BillingAddress/Line1 | Yes |
Line# components of the street address and, if necessary, suite and building identifiers for the physical address. Line1 is required. Get this value from Paze SDK JS checkoutResponse.maskedCard.billingAddress.line1 Line2, Line3, and Line4 are optional. Include them only if the data exists. A blank AddressLine element will fail validation. |
String |
1 to 70 characters. |
| CreditCardAuthRequest/BillingAddress/Line2 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/BillingAddress/Line3 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/BillingAddres/Line4 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/BillingAddress/City | Yes | Name of the city. Get this value from Paze SDK JS checkoutResponse.maskedCard.billingAddress.city | String | Min 1 character Max 40 characters |
| CreditCardAuthRequest/BillingAddress/MainDivision | No | Two- or three-digit postal abbreviation for the state or province. The ISO 3166-2 code is recommended, but not required. See http://en.wikipedia.org/wiki/ISO_3166-2. Get this value from Paze SDK JS checkoutResponse.maskedCard.billingAddress.state | String | Min 1 character Max 35 characters |
| CreditCardAuthRequest/BillingAddress/CountryCode | Yes | Two digit ISO 3166 alpha 2 code country code. See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 Get this value from Paze SDK JS checkoutResponse.maskedCard.billingAddress.countryCode | String | Min 2 characters Max 40 characters |
| CreditCardAuthRequest/BillingAddress/PostalCode | No | String of letters and/or numbers that specifies the delivery area more closely than the city alone (for example, US ZIP code). Get this value from Paze SDK JS checkoutResponse.maskedCard.billingAddress.zip | String | Min 1 character Max 15 characters |
| CreditCardAuthRequest/CustomerEmail | Yes | Email address of the customer who is making the purchase. Used for realtime fraud checking by our API and payment processors. Get this value from Paze SDK JS checkoutResponse.consume.emailAddress | String | Min 1 character Max 70 characters |
| CreditCardAuthRequest/CustomerIPAddress | Yes | IP address of the customer who is making the purchase. Used for realtime fraud checking by our API and payment processors. | IPv4Address | Valid dotted quad IPv4 Address |
| CreditCardAuthRequest/ShipToFirstName | Yes | First name of the person on the first/primary shipping address of the order. Used for realtime fraud checking by our API and payment processors. Get FirstName value from Paze SDK JS checkoutResponse.shippingAddress.deliveryContactDetails.contactFullName | String | |
| CreditCardAuthRequest/ShipToLastName | Yes | Last name of the person on the first/primary shipping address of the order. Used for realtime fraud checking by our API and payment processors. Get LastName value from Paze SDK JS checkoutResponse.shippingAddress.deliveryContactDetails.contactFullName | String | |
| CreditCardAuthRequest/ShipToPhoneNo | No | Phone number of the person on the first/primary shipping address of the order. Used for realtime fraud checking by our API and payment processors. Get this value from Paze SDK JS checkoutResponse.shippingAddress.deliveryContactDetails.contactPhoneNumber | String | |
| CreditCardAuthRequest/ShippingAddress | Yes | First/primary shipping address of the order. Used for realtime fraud checking by our API and payment processors. For orders that do not have a shipping address, pass the billing address as the shipping address. | ComplexType | |
| CreditCardAuthRequest/ShippingAddress/Line1 | Yes |
Line# components of the street address and, if necessary, suite and building identifiers for the physical address. Line1 is required. Get this value from Paze SDK JS checkoutResponse.shippingAddress.line1 Line2, Line3, and Line4 are optional. Include them only if the data exists. A blank AddressLine element will fail validation. |
String |
1 to 70 characters. |
| CreditCardAuthRequest /ShippingAddress/Line2 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/ShippingAddress/Line3 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/ShippingAddress/Line4 | No |
String |
1 to 70 characters. |
|
| CreditCardAuthRequest/ShippingAddress/City | Yes | Name of the city. Get this value from Paze SDK JS checkoutResponse.shippingAddress.city | String | Min 1 character Max 40 characters |
| CreditCardAuthRequest/ShippingAddress/MainDivision | No |
Two- or three-digit postal abbreviation for the state or province. The ISO 3166-2 code is recommended, but not required. See http://en.wikipedia.org/wiki/ISO_3166-2. Get this value from Paze SDK JS checkoutResponse.shippingAddress.state |
String | Min 1 character Max 35 characters |
| CreditCardAuthRequest/ShippingAddress/CountryCode | Yes | Two digit ISO 3166 alpha 2 code country code. See: http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 Get this value from Paze SDK JS checkoutResponse.shippingAddress.countryCode | String | Min 2 characters Max 40 characters |
| CreditCardAuthRequest/ShippingAddress/PostalCode | No |
String of letters and/or numbers that specifies the delivery area more closely than the city alone (for example, U.S. ZIP code). Get this value from Paze SDK JS checkoutResponse.shippingAddress.zip |
String | Min 1 character Max 15 characters |
| Features/IncludePaymentAccountInformation | No | Flag to get bin prefix, pan suffix and original pan suffix in reply | Boolean | true or false |
Response Examples
Success Response
<?xml version="1.0" encoding="UTF-8"?>
<CreditCardAuthReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
<PaymentContext>
<OrderId>1</OrderId>
<!-- You will receive a token in the response, which is a scrambled version of the Credit Card number. This token gets passed to the Order Service, not the original credit card number -->
<PaymentAccountUniqueId isToken="true">4054131ImpMJ6965</PaymentAccountUniqueId>
</PaymentContext>
<ResponseCode>APPROVED</ResponseCode>
<AuthorizationResponseCode>AP01</AuthorizationResponseCode>
<BankAuthorizationCode>614653</BankAuthorizationCode>
<CVV2ResponseCode>0</CVV2ResponseCode>
<AVSResponseCode>E</AVSResponseCode>
<AmountAuthorized currencyCode="USD">14.99</AmountAuthorized>
<TenderType>VC</TenderType>
<PaymentAccountInformation>
<BinPrefix>4054131</BinPrefix>
<PanSuffix>6965</PanSuffix>
<OriginalPanSuffix>1991</OriginalPanSuffix>
</PaymentAccountInformation>
</CreditCardAuthReply>Response Elements
| Element | Required | Description | Type | Restriction |
|---|---|---|---|---|
| CreditCardAuthReply/PaymentContext | Yes |
Unique identifier of the payment transaction for the order |
ComplexType | |
| CreditCardAuthReply/PaymentContext/ OrderId |
Yes | Unique identifier of the order. The client must ensure uniqueness of OrderIds across all orders that the client initiates with this service. | String | Min 1 character Max 20 characters |
| CreditCardAuthReply/PaymentContext/ PaymentAccountUniqueId |
Yes |
Token (scrambled version) of the PAN (payment account number such as a credit card number). When passing the PAN for the PaymentAuthCancelRequest and the PaymentSettlementRequest messages, always use the returned token, not the original PAN. |
String | Min 1 character Max 22 characters |
| CreditCardAuthReply/PaymentContext/ PaymentAccountUniqueId/ @isToken |
Yes | Attribute that indicates whether the PAN is tokenized. In the CreditCardAuthReply message, this attribute is always set to true. | String | true |
| CreditCardAuthReply/ResponseCode | No |
Response code of the credit card authorization. Includes approved, timeout, and several decline codes. Only orders with an approved or timeout response code are submitted to the Order Service. See Authorization Response Codes for a list of codes. |
String |
SchemaVersion in the Request Message has to be equal to or greater than 1.1 in order to receive this element |
| CreditCardAuthReply/ AuthorizationResponseCode |
Yes |
Response code of the credit card authorization. This includes approval, timeout, and several decline codes. See Authorization Response Codes for a list of codes. |
String | |
| CreditCardAuthReply/BankAuthorizationCode | Yes |
Authorization code returned by the payment processor upon a successful credit card authorization. Any order taken by the Order Service and paid by credit card MUST have this authorization code. |
String | |
| CreditCardAuthReply/CVV2ResponseCode | Yes |
Payment processor response code for the CVV2 (card verification value) check. For most credit cards, you get an approval on the ResponseCode even if the CVV2ResponseCode returns a CVV2 failure. You CANNOT accept an order if the CVV2ResponseCode returns a CVV2 failure code. See CVV2 Response Codes for a list of codes. |
String | |
| CreditCardAuthReply/AVSResponseCode | Yes |
Payment processor response for the Address Verification System (AVS) check. For most credit cards, you get an approval on the ResponseCode even if the AVSResponseCode returns an AVS failure code. It is typically considered a significant fraud risk to accept an order if the AVSResponseCode returns an AVS failure code. See AVS Response Codes for a list of codes. |
String | |
| CreditCardAuthReply/PhoneResponseCode | No (Amex only) |
Response code for customer phone number verification. Only applies to Amex authorizations. To support downstream fraud processing, this data should be included in the OrderCreateRequest for orders paid with Amex. |
String | |
| CreditCardAuthReply/NameResponseCode | No (Amex only) |
Response code for customer name verification. Only applies to Amex authorizations. To support downstream fraud processing, this data should be included in the OrderCreateRequest for orders paid with Amex. |
String | |
| CreditCardAuthReply/EmailResponseCode | No (Amex only) |
Response code for customer email verification. Only applies to Amex authorizations. To support downstream fraud processing, this data should be included in the OrderCreateRequest for orders paid with Amex. |
String | |
| CreditCardAuthReply/AmountAuthorized | Yes | Currency amount authorized on the credit card | String |
Positive decimal, up to two decimal places(for example, 4.75) |
| CreditCardAuthReply/AmountAuthorized/ @currencyCode |
Yes | Type of currency used for the order | String | 3-character ISO 4217 code (for example, USD, CAD, EUR). See http://en.wikipedia.org/wiki/ISO_4217. |
| CreditCardAuthReply/TenderType | No (Always present for Digital Wallet transactions) | This element identifies the
tender type used for the transaction
*Note that this value might be corrected based on Bin Range identification |
String | Min 2 characters Max 4 Characters SchemaVersion in the Request Message has to be equal to or greater than 1.2 in order to receive this element for Card Not Present and Card Present transactions |
| CreditCardAuthReply/Extension | No | This element indicates that future optional elements may show up in this location of the XML document in the responses returned from the service. | ||
| PaymentAccountInformation/BinPrefix | No | Bin prefix (first 6 digits of PAN) | String | Max 10 characters |
| PaymentAccountInformation/PanSuffix | No | Pan Suffix (last 4 digits of a PAN) | String | Max 10 characters |
| PaymentAccountInformation/OriginalPanSuffix | No | Original Pan Suffix (last 4 digits of PAN) Subject to availability of the data |
String | Max 10 characters |