On This Page
REST API
orderInformation. shipTo.postalCode
Postal code for the shipping address.
The postal code must consist of 5 to 9 digits.
Canada
Format
: [alpha][numeric][alpha][space][numeric][alpha][numeric]Example
: A1B 2C3U.S.
Format
: [5 digits][dash][4 digits]Example
: 12345-6789- 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 U.S. and U.S. territories. When you do not include this field in the request, the value for theorderInformation.billTo.postalCodefield 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,, andWorldpay VAP
- This value is the same as the value fororderInformation.shippingDetails.shipFromPostalCodewhen your customer takes possession of the items at your location.
- FDC Nashville Global,FDMS Nashville,FDMS South, andRBS 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, theorderInformation.billTo.postalCodevalue from the authorization request is used.
Tax Calculation
When
orderInformation.shipTo.postalCode
is not included in the request and the
service defaults to orderInformation.billTo.postalCode
, the value for orderInformation.shipTo.postalCode
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.
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: not applicable
- 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: not applicable
- FDMS South: not applicable
- 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