GuidesAPI Reference
Guides

Confirm Transaction

Suggest Edits

You need to confirm stored transactions.

You can use the following URL and a POST method to achieve this:

{service_URL}/api/v3/marketplace/transactions/{key}/confirm

where:

  • {service_URL} is the URL of the environment.
  • {key} is the transaction key value. This specifies which transaction you wish to confirm.

📘

Note

If a Confirm Transaction fails, for example due to a network error, you should send a Confirm Transaction request again using the same Transaction Key to ensure it is completed successfully. If you create a new transaction with a Store Transaction request, this may cause a duplicate to be created.

Details

TypeValue
Endpoint/api/v3/marketplace/transactions/{key}/confirm
MethodPOST
API Reference DocumentationConfirm Transaction

Where {key} is the transaction key value. This specifies which transaction you wish to confirm.

Request Example

For example:

curl --request POST \
  --url https://marketplace-api.sandbox.marketplace.taxamo.com/api/v3/marketplace/transactions/PJyj7WQAAAAYTSOvTCmQLpBvs7KRe1lL6v3GSnQ/confirm \
  --header 'content-type: application/json' \
  --header "x-marketplace-token: $TOKEN" \
  --data '{}'

Response Example

The following example shows the information returned by the service:

{
   "transaction" : {
      "create_timestamp" : "2020-06-02T13:24:10Z",
      "external_unique_id" : null,
      "product_classes" : "P",
      "amount" : 300,
      "invoice_image_url_secret" : "oWHiiUepYXbeZvzd",
      "key" : "PJyj7WQAAAAYTSOvTCmQLpBvs7KRe1lL6v3GSnQ",
      "ship_to_address" : {
         "postal_code" : "BA1 2AP",
         "city" : "Bath",
         "country_code" : "GB",
         "street_name" : "30 Monmouth Street"
      },
      "description" : "Example sale to GB.",
      "invoice_timestamp" : "2020-05-20T01:59:59+04:00",
      "required_fields" : {
         "tax_required_fields" : [],
         "storage_required_fields" : [],
         "audit_required_fields" : []
      },
      "total_amount" : 320,
      "invoice_address" : {
         "city" : "Bath",
         "country_code" : "GB",
         "street_name" : "30 Monmouth Street",
         "postal_code" : "BA1 2AP"
      },
      "currency_code" : "EUR",
      "invoice_place" : "VILLENEUVE D'ASCQ, 4 BD DE MONS",
      "transaction_lines" : [
         {
            "product_class" : "P",
            "tax_region" : "EU",
            "taxes" : [],
            "tax_liability_owner_code" : "buyer",
            "carrier_id" : "DHL",
            "product_cn_code" : "8504 31 80 15",
            "parcel_reference" : "3897329872423",
            "tax_entity_name" : "United Kingdom",
            "quantity" : 1,
            "product_reference_number" : "",
            "invoice_image_url_secret" : "oWHiiUepYXbeZvzd",
            "invoice_number" : "GB2020-1",
            "deducted_tax_rate" : 0,
            "tax_engine" : "taxamo",
            "line_key" : "mpbZeqL1Dclo52tp",
            "total_amount" : 200,
            "tax_country_code" : "GB",
            "tax_number_service" : "vies",
            "line_num" : 1,
            "tax_address_kind" : "ship-to-address",
            "seller_code" : "EU1M",
            "reverse_charge" : false,
            "tax_supported" : true,
            "amount" : 200,
            "tax_liability_rule" : "physical-shipment-into-EU-goods-above-150-eur",
            "kind" : "b2c",
            "unit_price" : 200,
            "custom_id" : "line_1",
            "ship_from_address" : {
               "country_code" : "CN"
            },
            "invoice_image_url" : "{invoice_url}",
            "deducted_tax_amount" : 0,
            "description" : "Goods #1"
         },
         {
            "invoice_number" : "GB2020-3",
            "invoice_image_url_secret" : "oWHiiUepYXbeZvzd",
            "product_reference_number" : "",
            "tax_engine" : "taxamo",
            "line_key" : "5fdQ8TiVelhNXMrZ",
            "tax_country_code" : "GB",
            "total_amount" : 120,
            "tax_region" : "EU",
            "taxes" : [
               {
                  "amount_fraction_taxable" : 1,
                  "rate" : 20,
                  "tax_name" : "European VAT physical",
                  "rate_type" : "Standard"
               }
            ],
            "tax_amount" : 20,
            "product_class" : "P",
            "tax_liability_owner_code" : "P1",
            "product_cn_code" : "8504 31 80 15",
            "parcel_reference" : "3897329872423",
            "carrier_id" : "DHL",
            "quantity" : 1,
            "tax_entity_name" : "United Kingdom",
            "tax_supported" : true,
            "kind" : "b2c",
            "tax_liability_rule" : "physical-shipment-inside-EU-seller-outside-EU",
            "amount" : 100,
            "back_to_back_external_unique_id" : "PJyj7WQAAAAYTSOvTCmQLpBvs7KRe1lL6v3GSnQ.P.PL.8",
            "ship_from_address" : {
               "country_code" : "PL"
            },
            "custom_id" : "line_2",
            "back_to_back_invoice_country_code" : "PL",
            "unit_price" : 100,
            "description" : "Goods #2",
            "back_to_back_transaction_key" : "PUEp5agAAAAg3V1FBAAAAAEFBQVkAAA5pVFNPdlBKeWo3V1FBQUFBWVRTT3ZUQ21RTHBCdnM3S1JlMWxMNnYzR1NuUS5QLlBMLjg",
            "invoice_image_url" : "{invoice_url}",
            "line_num" : 2,
            "tax_number_service" : "vies",
            "seller_code" : "CN1M",
            "tax_address_kind" : "ship-to-address",
            "reverse_charge" : false
         }
      ],
      "marketplace_code" : "P1",
      "update_timestamp" : 1591104250934,
      "tax_liability_owner_codes" : "buyer,P1",
      "invoice_capable" : true,
      "tax_amount" : 20,
      "rev" : 1,
      "location_evidence" : {},
      "status" : "C",
      "test" : false,
      "buyer_name" : "Scenario #1 buyer",
      "tax_country_codes" : "GB",
      "confirm_timestamp" : "2020-06-02T13:25:29Z"
   }
}

Updated 4 months ago