REST API

orderInformation. shipTo.postalCode

Postal code for the shipping address.
The postal code consists of 5 to 9 digits.
  • Canadian postal code
    : The six-digit format is
    [alpha][numeric][alpha][space] [numeric][alpha][numeric]
    Example: A1B 2C3
  • US postal code
    : The nine-digit format is
    [5 digits][dash][4 digits]
    .
    Example: 12345-6789
Tax Calculation
When the
orderInformation.shipTo.postalCode
field is not included in the request and the service defaults to
orderInformation.billTo.postalCode
, the value for the
orderInformation.shipTo.postalCode
field is left blank in the Tax Detail Report.
When the postal code for the shipping address is not included in the request message, the postal code for the billing address is used for Tax Calculation. When the postal code for the billing address is not included in the request message, the postal code for the shipping address is required.
This field is available only on these processors:
American Express Direct
,
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
FDMS Nashville
,
FDMS South
,
GPN
,
OmniPay Direct
,
RBS WorldPay Atlanta
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
.
These processors have specific requirements:
American Express Direct
Before sending the postal code to the processor, all non-alphanumeric characters are removed. When the remaining value is longer than nine characters, the value is truncated starting from the right side.
The postal code is required for Level II processing in the US and US territories. When you do not include this field in the request, the value for the
orderInformation.billTo.postalCode
field is used. When you do not include either field, the value in your account is used.
Chase Paymentech Solutions
,
Elavon Americas
,
FDC Compass
,
FDC Nashville Global
,
OmniPay Direct
,
TSYS Acquiring Solutions
,
Visa Platform Connect
, and
Worldpay VAP
This value is the same as the value for
orderInformation.shippingDetails.shipFromPostalCode
when your customer takes possession of the items at your location.
FDC Nashville Global
,
FDMS Nashville
,
FDMS South
, and
RBS WorldPay Atlanta
If the postal code for the shipping address is not included in the request message, the postal code for the billing address is used. If the postal code for the billing address is not included in the request message, the postal code for the shipping address is required.
Worldpay VAP
It is recommended that this value not exceed 10 characters. If this value is not included in the request, the
orderInformation.billTo.postalCode
value from the authorization request is used.

Specifications

  • Data Type:
    String
  • Data Length:
    10

Mapping Information

  • REST API Field:
    orderInformation.shipTo.postalCode
  • SCMP API Field:
    ship_to_zip
  • Simple Order API Field:
    shipTo_postalCode

Processor Field Names

This list provides the Level II/Level III processor field name for each processor that supports Level II or Level III data:
  • American Express Direct
    : Does not apply
  • Chase Paymentech Solutions
    : Destination ZIP/Postal Code
  • Elavon Americas
    : Destination ZIP/Postal Code
  • FDC Compass
    : Destination ZIP/Postal Code
  • FDC Nashville Global
    : Destination ZIP
  • FDMS Nashville
    : Does not apply
  • FDMS South
    : Does not apply
  • GPN
    : Destination Postal/ZIP Code
  • OmniPay Direct
    : Destination Postal/ZIP Code
  • RBS WorldPay Atlanta
    : Destination ZIP
  • TSYS Acquiring Solutions
    : Destination Postal/ZIP Code
  • Visa Platform Connect
    : shipToAddress
  • Worldpay VAP
    : destinationPostalCode