CargoPoint Using E-Bond
Distributable CargoPoint Table of Contents
Table of Contents...... i Change History...... ii Introduction...... 1 Preparing for E-Bond...... 2 Configuring CargoPoint for E-Bond...... 3 Requesting a STB from the Surety Agent Web Service...... 9 Manually Entering a STB or Entering via Surety Webpage...... 13 Manually Removing a STB...... 15 Additional “To ABI” Validation...... 16
Using E-Bond i CargoPoint Change History
Rev Date Who Description of change 0 2015-07-31 L. Brown Initial version 1 2015-08-10 L. Brown Added section Manually Removing a STB. 2 2015-09-11 L. Brown Updated screen shots. 3 2015-09-15 L. Brown Configurable Exception Contact information added to E-Bond screen. 4 2015-12-09 L. Brown Added complete Special Parameters list. 5 2016-04-01 L. Brown Disallowed Action fields added to Surety Agents screen. Last Send Action fields added to E-Bond screen to indicate Send Actions last saved to the database. 6 2016-04-01 D. Myers Added more description for Manually Entering STB.
Using E-Bond ii CargoPoint Introduction
Brokers using CargoPoint CHB can now file requests for Single Transaction Bonds (STBs) directly with a Surety Agent via a web service provided by the Surety Agent. STB requests can be made for Customs Entries and ISF Transactions.
As an alternative to using the Surety Agent web service, Brokers can manually file requests for STBs using a web portal provided by the Surety Agent, and upon approval of the requests, manually enter the Bond Numbers provided by the Surety Agent into CargoPoint CHB.
Using E-Bond 1 CargoPoint Preparing for E-Bond
Brokers must contact the Surety Agent to establish a secure relationship between them for the Surety Agent web service. The Broker will need to provide the following information to the Surety Agent:
The ABI filer code of the Broker
A username, up to 50 characters in length, that identifies the Broker to the Surety Agent; the ABI file code of the Broker may be acceptable as the user name, at the discretion of the Surety Agent
A password (“shared secret”), up to 50 characters in length, that is known only to the Broker and the Surety Agent
Other identifying and contact information, at the discretion of the Surety Agent
The Surety Agent will provide the following information about their web service:
The ABI filer code of the Surety Agent
Identifying and contact information for the Surety Agent
The URL of the web service
Optionally, a username and password for Basic HTTP Authentication of calls to the web service
Send actions that the web service supports
An indication if the value (Entry Number) in the Nonce tag in the Username Token provided by the Broker must be base64-encoded
An indication if the Nonce (Entry Number) in the Password in the Username Token provided by the Broker must be base64-encoded
If the Broker requests use of the Surety Agent web portal for manual STB requests, then the Surety Agent will provide the following information about their web portal:
The URL of the web portal
Login credentials for the web portal
Using E-Bond 2 CargoPoint Configuring CargoPoint for E-Bond
The information provided by the Surety Agent must be entered into the Surety Agents table in CargoPoint. To do this, run CHB and go to menu item Tables / Customs Tables / Surety Agents. Add a new record for the Surety Agent or modify an existing record for the Surety Agent.
Enter information for the Surety Agent in the Surety Agents screen fields as follows:
Code
The ABI filer code of the Surety Agent
Using E-Bond 3 CargoPoint Name, Contact, Title, E-mail, Phone
Contact information for the Surety Agent
eBond Web Site URL
The URL of the Surety Agent web portal
eBond Registration URL
The URL of the Surety Agent registration web service, currently not used by CargoPoint
eBond Service URL
The URL of the Surety Agent web service
eBond Service Special Parameters
A comma-delimited list of key/value pairs (format key=value) for the following optional parameters:
RequestTimeout
Controls the time allowed, in seconds, for a response from the Surety Agent web service for a submitted STB request before a timeout is declared.
Values
“60” or numeric value <= 0
(Default) 60
Integral numeric value > 0
ContentType
Controls the Content-Type header parameter in the STB request.
Values
Blank or “text/xml; charset=utf-8”
(Default)
Using E-Bond 4 CargoPoint “text/xml; charset=utf-8”
Valid Content-Type specifier
Base64EncodeNonceTag
Controls the base64-encoding of the value (Entry Number) in the Nonce tag in the Username Token provided by the Broker.
Values
“N”
(Default) The value (Entry Number) in the Nonce tag in the Username Token provided by the Broker will not be base64-encoded
“Y”
The value (Entry Number) in the Nonce tag in the Username Token provided by the Broker will be base64-encoded
Base64EncodeNoncePassword
Controls the base64-encoding of the Nonce (Entry Number) in the Password in the Username Token provided by the Broker.
Values
“N”
(Default) The Nonce (Entry Number) in the Password in the Username Token provided by the Broker will not be base64-encoded
“Y”
The Nonce (Entry Number) in the Password in the Username Token provided by the Broker will be base64-encoded
BodyXMLNS
Controls the XML namespace specified in the Body tag of the STB request.
Values
Using E-Bond 5 CargoPoint
Blank
(Default) “”
Valid XML namespace specifier
RequestCompression
Controls the compression used to reduce the size of the STB request body that is transmitted to the Surety Agent web service.
Values
“NONE”
(Default) No compression
“GZIP”
GZip compression
“DEFLATE”
Deflate compression
eBond Service Username
The username for Basic HTTP Authentication of calls to the web service
eBond Service Password
The password for Basic HTTP Authentication of calls to the web service
eBond Message Username
The username provided by the Broker to the Surety Agent
eBond Message Password
The password (“shared secret”) provided by the Broker to the Surety Agent
eBond STB Disallowed Actions
Using E-Bond 6 CargoPoint A list of STB Send Action codes that the web service does not support, or that the CargoPoint user should not use, e.g. “AUER”
Possible STB Send Actions are:
Code Description B Add a new basic bond A Additional bond; for AD/CVD, PGA, etc. V Void the STB on file C Adjust the bond amount of the STB on file U Substitute for the bond presented at time of entry E Supersede the bond presented at time of entry R Bond Rider to take the following actions: US Virgin Islands M Manually entered on Surety Site T Test Connection to Surety Site
eBond ISF Disallowed Actions
A list of ISF Bond Send Action codes that the web service does not support, or that the CargoPoint user should not use, e.g. “R”
Possible ISF Bond Send Actions are:
Code Description B Add a new basic bond V Void the ISF Bond on file C Adjust the bond amount of the ISF Bond on file R Bond Rider to take the following actions: US Virgin Islands M Manually entered on Surety Site T Test Connection to Surety Site
Any Sureties that use the Surety Agent must be associated with the Surety Agent. To do this, run CHB and go to menu item Tables / Customs Tables / Surety Codes. Add new records for the Sureties or modify existing records Sureties.
Using E-Bond 7 CargoPoint
Click the ? button on the data entry screen and enter the ABI filer code of the Surety Agent in the Agent Filer Code screen field. The Agent Filer Code screen field is an F4-key lookup to the Surety Agents table.
Using E-Bond 8 CargoPoint Requesting a STB from the Surety Agent Web Service
To request a STB from the Surety Agent via their web service, run CHB and open its Open Entry screen to display a list of shipments.
If the shipment is qualified for ACE Cargo Release (ACE Column Position 2 = Q), the Bond Type of the shipment is 9 (Single Entry Bond), and the bond information is complete, then the eBond button will be red.
Using E-Bond 9 CargoPoint
Click the eBond button.
Select a source for Exception Contact information, or select no source and manually enter the information in the boxes provided.
Select a Send Action for either a Customs Entry Single Transaction Bond or ISF Bond, and click the adjoining Verify button to validate the shipment for transmission
Using E-Bond 10 CargoPoint of the STB request to the Surety Agent web service. If the shipment validates, then the status adjoining the Send Action will become OK, and the adjoining Send button will become enabled. If the shipment does not validate, then a list of validation errors will be displayed.
Click the adjoining Send button to transmit the STB request to the Surety Agent web service. A shipment history record is created that indicates the transmission.
After the STB request is transmitted to the Surety Agent web service, the Surety Agent web service will either respond with an immediate acceptance/rejection by the Surety, or will report a delay in submission to CBP for approval due to a condition such as pending underwriter review. A shipment history record is created that indicates the immediate response.
Regardless of whether you submit a bond request via the Surety Agent web service or manually via the Surety Agent web portal, once the Surety Agent submits the STB to CBP, then the CBP statuses of the STB will be reported to CargoPoint via an ABI BS transaction. CBP will send an ABI BS transaction to the broker as long as the Secondary Notify Party is properly declared in the STB request. The ABI BS transaction will attach to the shipment and update the Bond number. A shipment
Using E-Bond 11 CargoPoint history record is created that indicates the receipt and processing of the ABI BS transaction.
Once the Bond Number exists in the shipment, you will be able to transmit it to CBP.
If there are issues you can view more detailed statuses of the bond requests by logging into the Surety Agent web portal.
Below is an example of a BS transaction from CargoPoint’s ABI Notes.
Using E-Bond 12 CargoPoint Manually Entering a STB or Entering via Surety Webpage
All Sureties qualified for ACE allow you to enter the E-Bond information on their web page and obtain a Bond Number. If you put in your Port and Filer code as a “Notify Party” then when the Bond gets approved CBP will send a “BS” Bond Status message as shown above and it will update the Bond number for your Entry automatically. This will allow you to then send the entry.
If for some reason you forgot to enter yourself as a Notify party or the BS message didn’t come from CBP you can manually obtain the bond number from the Surety Agent via their web portal, then its Bond Number can be manually entered in the E- Bond screen per below instructions.
Select Send Action M, enter the Bond Number into the Bond No. field, and click the Verify button to validate the Bond Number. If the Bond Number validates, then the status will become OK.
Using E-Bond 13 CargoPoint
Click the OK button to save the Bond Number. A shipment history record is created that indicates the manual entry of the STB.
Using E-Bond 14 CargoPoint Manually Removing a STB
A Bond Number can be manually removed in the E-Bond screen.
Select Send Action M, clear the Bond No. field, and click the OK button. You will asked to verify the removal of the Bond Number.
Click the Yes button. A shipment history record is created that indicates the manual removal of the STB.
Using E-Bond 15 CargoPoint Additional “To ABI” Validation
On CHB’s Open Entry screen, an E-Bond related validation has been added to the “To ABI” button to prevent a shipment from being sent to ABI when the following conditions are met:
ACE CR = Q (Position 2 in the ACE column) Bond Type = 9 The shipment has no STB Bond Number
Using E-Bond 16