Process transaction

Use this request to process a shipping transaction.

You can use this request to generate a quote or to process a transaction.

To process a transaction use a POST operation and the following URL:

{epal_api_url}/transaction

For example:

https://api.epalglobal.com//transaction

Details

Table 1. Request Details
Detail
Operation	POST
Endpoint	`/transaction`
Fields	Response parameters

Response Parameters

Table 2.
Response Parameter	Details	Description
`addresses` object	Type: Object	Groups address fields.
`addresses.city`	Type: String	The name of the city
`addresses.companyName`	Type: String	The name of the company.
`addresses.country`	Type: String	The country where the address is.
`addresses.email`	Type: String	The email contact for the address.
`addresses.fullname`	Type: String	The full name of the contact at the address.
`addresses.phone`	Type: String	The phone number of the contact at the address.
`addresses.postalCode`	Type: String	The address's postal code.
`addresses.state`	Type: String	The state or country subdivision.
`addresses.street`	Type: String	The street name.
`addresses.type`	Type: String	The type of address.
`clientReference`	Type: String	Custom string added by the client that can be used to identify the transaction.
`date`	Type: Date and Time string	The time and date of the transaction.
`deniedParties`	Type: Object	Groups information about denied parties.
`deniedParties.recipient` object	Type: Object	Groups information about receipients who are amongst the denied parties.
`deniedParties.recipient.listsMatched`	Type: Number	The lists that the denied party was matched against.
`deniedParties.recipient.matches`	Type: Array of objects	The matches for the recipient.
`deniedParties.recipient.scoreCalculated`	Type: Number	The score for the denied recipient.
`grossWeight`	Type: Number	The gross weight of the goods in this transaction.
`isIOSSCompliant`	Type: Boolean	Indicats whether or not the transaction is IOSS compliant.
`products`	Type: Object	Groups product related fields.
`products.clientSKU`	Type: String	The client's Stock-Keeping Unit (SKU) code.
`products.compliance`	Type: Object	Groups compliance information.
`products.compliance.clearanceCodes`	Type: Array of strings	Codes that relate to the clearance status with customs.
`products.compliance.exportCodes`	Type: Array of strings	Codes that specify details about the export.
`products.compliance.hasProhibited`	Type: Boolean	Indicates whether the product has any prohibitions or not.
`products.compliance.hasRestricted`	Type: Boolean	Indicates whther the product has any restrictions or not.
`products.compliance.importCodes`	Type: Array of strings	Codes that specify details about the import.
`products.compliance.requiresCertificates`	Type: Boolean	Indicates whether the product requires certificates.
`products.compliance.requiresLicences`	Type: Boolean	Indicates whether the product requires certificates.
`products.compliance.transportCodes`	Type: Array of strings	Codes that detail informaiton about how the product is transported.
`products.customsDuty`	Type: Object	Groups information about customs duties.
`products.customsDuty.additiobnalDutyAmount`	Type: Number	The amount of any additional customs duty due.
`product.customsDuty.additiobnalDutyRate`	Type: Number	The rate for any additional customs duty due.
`products.customsDuty.CustomsDutyAmount`	Type: Number	The amount of customs duty due.
`products.customsDuty.CustomsDutyRate`	Type: Number	The rate of the customs duty.
`products.description`	Type: String	A description of the product.
`products.hs6code`	Type: String	The HS6 code for the product.
`products.originatingCountry`	Type: String	The country of origin.
`products.productType`	Type: String Enummeration Possible Values: `"physical"`, `"digital"` or `"shipping"`.	Specifies the type of goods. This can be `"physical"`, `"digital"`, or `"shipping"`.
`products.qty`	Type: Number	The quantity of goods in the transaction.
`products.tax`	Type: Object	Groups tax information.
`products.tax.DestinationCountry`	Type: Object	Groups tax information about the country where the goods are sent to.
`products.tax.DestinationCountry.taxAmount`	Type: Number	The amount of tax due in the destination country.
`products.tax.DestinationCountry.taxOnDutyAmount`	Type: Number	The tax that is due on the custom duties.
`products.tax.DestinationCountry.taxRate`	Type: Number	The rate of tax in the destination country.
`products.tax.sourceCountry`	Type: Object	Groups tax information about the goods that the goods are sent from.
`products.tax.sourceCountry.taxAmount`	Type: Number	The amount of tax for the product in the country that it was sent from.
`products.tax.sourceCountry.taxRate`	Type: Number	The tax rate for the product in the country that it was sent from.
`products.taxExclusiveValue`	Type: Number	The price of the good excluding tax.
`products.taxInclusiveValue`	Type: Number	The price of the goods including tax.
`products.value`	Type: Number	The value of the products.
`sessionId`	Type: String	The ID that identifies the transaction.
`shipping`	Type: Object	Groups information about shipping.
`shipping.enabled`	Type: Boolean	Indicates whether shipping is enabled or not.
`shipping.parcel`	Type: Object	Groups information about the parcel.
`shipping.parcel.height`	Type: Number	The height of the parcel.
`shipping.parcel.length`	Type: Number	The length of the parcel.
`shipping.parcel.template`	Type: String	The template.
`shipping.parcel.weight`	Type: Number	The weight of the parcel.
`shipping.parcel.width`	Type: Number	The width of the parcel.
`shipping.provider`	Type: String	The name of the shipping provider.
`shipping.rateId`	Type: String	The ID for the shipping rate.
`shipping.rates`	Type: Object	Groups information about shipping rates.
`shipping.rates.carrier`	Type: Object	Groups information about the carrier.
`shipping.rates.carrier.code`	Type: String	The code that represents the carrier.
`shipping.rates.carrier.name`	Type: String	The name of the carrier.
`shipping.rates.estimatedDeliveryDays`	Type: Number	The estimated number of days for delivery.
`shipping.rateId`	Type: String	The ID for the shipping rate.
`shipping.rates.name`	Type: String	The name of thte shiping rate.
`shipping.rates.price`	Type: Object	Groups information about the price.
`shipping.rates.price.amount`	Type: Number	The price.
`shipping.rates.price.currency`	Type: String	The price's currency
`shipping.rates.shipmentId`	Type: String	The identifier for the shipment.
`shipping.rates.signatureRequired`	Type: Boolean	Indicates whether a signature is required or not.
`shipping.rates.trackingIncluded`	Type: Boolean	Indicates whether tracking is included or not.
`shipping.shipmentId`	String	The shipment's ID.
`shipping.shippingCost`	Type: Number	Ths cost of shipping.
`shipping.shippingCostWithTax`	Type: Number	The cost of shipping including tax.
`shipping.shippingTaxAmount`	Type: Number	The amount of tax due for the shipping.
`shipping.shippingTaxRate`	Type: Number	The rate of tax that is used to calculate the amount of tax due on shipping.
`shipping.totalCostWithShipping`	Type: Number	The total cost of the goods, including shipping.
`transactionCurrency`	Type: String	The currency that the transaction uses.
`transactionValue`	Type: Number	The value of the transaction.
`warnings`	Type: Array of strings	The messages associated with the transaction.

Response Example

The following is an example response:

{
  "sessionId": "550e8400-e29b-41d4-a716-446655440000",
  "date": "2025-12-08T14:30:45.123Z",
  "grossWeight": 5.5,
  "transactionValue": 186.1,
  "transactionCurrency": "EUR",
  "clientReference": "ORDER-2025-12345",
  "addresses": [
    {
      "type": "SOURCE",
      "fullName": "string",
      "companyName": "string",
      "email": "string",
      "phone": "string",
      "street": "string",
      "city": "string",
      "postalCode": "string",
      "country": "string",
      "state": "string"
    }
  ],
  "products": [
    {
      "clientSKU": "string",
      "description": "string",
      "hs6Code": "string",
      "qty": 0,
      "value": 0,
      "taxExclusiveValue": 0,
      "taxInclusiveValue": 0,
      "productType": "physical",
      "originatingCountry": "string",
      "tax": {
        "destinationCountry": {
          "taxRate": 0,
          "taxAmount": 0,
          "taxOnDutyAmount": 0
        },
        "sourceCountry": {
          "taxRate": 0,
          "taxAmount": 0
        }
      },
      "customsDuty": {
        "customsDutyRate": 0,
        "customsDutyAmount": 0,
        "additionalDutyRate": 0,
        "additionalDutyAmount": 0
      },
      "compliance": {
        "exportCodes": [
          "string"
        ],
        "importCodes": [
          "string"
        ],
        "transportCodes": [
          "string"
        ],
        "clearanceCodes": [
          "string"
        ],
        "hasProhibited": true,
        "hasRestricted": true,
        "requiresLicenses": true,
        "requiresCertificates": true
      }
    }
  ],
  "shipping": {
    "enabled": true,
    "provider": "string",
    "shippingCost": 0,
    "shippingCostWithTax": 0,
    "shippingTaxRate": 0,
    "shippingTaxAmount": 0,
    "totalCostWithShipping": 0,
    "shipmentId": "string",
    "rateId": "string",
    "rates": [
      {
        "id": "string",
        "name": "string",
        "carrier": {
          "name": "string",
          "code": "string"
        },
        "price": {
          "amount": 0,
          "currency": "string"
        },
        "estimatedDeliveryDays": 0,
        "signatureRequired": true,
        "trackingIncluded": true,
        "shipmentId": "string"
      }
    ],
    "parcel": {
      "weight": 0,
      "width": 0,
      "length": 0,
      "height": 0,
      "template": "string"
    }
  },
  "warnings": [
    "string"
  ],
  "deniedParties": {
    "sender": {
      "scoreCalculated": 0,
      "listsMatched": 0,
      "matches": [
        {}
      ]
    },
    "recipient": {
      "scoreCalculated": 0,
      "listsMatched": 0,
      "matches": [
        {}
      ]
    }
  },
  "isIOSSCompliant": true
}